{ "openapi": "3.0.1", "info": { "title": "LIFE POS API", "version": "6" }, "paths": { "/orgs/{org_guid}/me": { "get": { "tags": [ "Me" ], "operationId": "GetCurrentEmployee", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "include_permissions", "in": "query", "schema": { "type": "boolean", "description": "include_permissions" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "1c82563c-184e-46ec-84f5-2a73ad36b785" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Me" }, "example": {"name":"Василий Пупки","role":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"Role"},"phone":"79991112233","username":"my_username","email":"my_username@vasil.ru","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"0d1bd031-7817-4b6f-a1f3-39944dfd3a9c","type_of":"Me"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager", "cashier", "courier", "guest" ] } ] } }, "/orgs/{org_guid}/me/set-credentials": { "post": { "tags": [ "Me" ], "operationId": "SetEmployeeCredentials", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "5bdee620-7977-4e85-aa58-902002fb9042" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserSetCredentials" }, "example": {"old_password":"my_new_passwd321","new_password":"my_old_passwd123"} }, "application/json": { "schema": { "$ref": "#/components/schemas/UserSetCredentials" }, "example": {"old_password":"my_new_passwd321","new_password":"my_old_passwd123"} }, "text/json": { "schema": { "$ref": "#/components/schemas/UserSetCredentials" }, "example": {"old_password":"my_new_passwd321","new_password":"my_old_passwd123"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserSetCredentials" }, "example": {"old_password":"my_new_passwd321","new_password":"my_old_passwd123"} } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAccess" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager", "cashier", "courier" ] } ] } }, "/orgs/{org_guid}/widgets/revenue": { "get": { "tags": [ "RevenueReportsWidgets" ], "operationId": "GetReportRevenueReportForWidget", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "current_period_from", "in": "query", "required": true, "schema": { "type": "string", "description": "current_period_from", "format": "date-time" } }, { "name": "current_period_to", "in": "query", "required": true, "schema": { "type": "string", "description": "current_period_to", "format": "date-time" } }, { "name": "previous_period_from", "in": "query", "required": true, "schema": { "type": "string", "description": "previous_period_from", "format": "date-time" } }, { "name": "previous_period_to", "in": "query", "required": true, "schema": { "type": "string", "description": "previous_period_to", "format": "date-time" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "1237a907-8b51-4da1-b6a1-03b88b55dd8a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueReportForWidget" } } } } } } }, "/orgs/{org_guid}/widgets/revenue/outlets": { "get": { "tags": [ "RevenueReportsWidgets" ], "operationId": "GetReportRevenueReportForOutletsWidget", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "current_period_from", "in": "query", "required": true, "schema": { "type": "string", "description": "current_period_from", "format": "date-time" } }, { "name": "current_period_to", "in": "query", "required": true, "schema": { "type": "string", "description": "current_period_to", "format": "date-time" } }, { "name": "previous_period_from", "in": "query", "required": true, "schema": { "type": "string", "description": "previous_period_from", "format": "date-time" } }, { "name": "previous_period_to", "in": "query", "required": true, "schema": { "type": "string", "description": "previous_period_to", "format": "date-time" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "max_results", "in": "query", "required": true, "schema": { "maximum": 10, "minimum": 1, "type": "integer", "description": "max_results", "format": "int32" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "ca0aa4dd-7033-459d-bf7a-8a491ffc1cb4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueReportForOutletsWidget" } } } } } } }, "/orgs/{org_guid}/widgets/revenue/employees": { "get": { "tags": [ "RevenueReportsWidgets" ], "operationId": "GetReportRevenueReportForEmployeesWidget", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "current_period_from", "in": "query", "required": true, "schema": { "type": "string", "description": "current_period_from", "format": "date-time" } }, { "name": "current_period_to", "in": "query", "required": true, "schema": { "type": "string", "description": "current_period_to", "format": "date-time" } }, { "name": "previous_period_from", "in": "query", "required": true, "schema": { "type": "string", "description": "previous_period_from", "format": "date-time" } }, { "name": "previous_period_to", "in": "query", "required": true, "schema": { "type": "string", "description": "previous_period_to", "format": "date-time" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "max_results", "in": "query", "required": true, "schema": { "maximum": 10, "minimum": 1, "type": "integer", "description": "max_results", "format": "int32" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "f889e81a-fb5a-485a-b6e9-16bb20b8edc7" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueReportForEmployeesWidget" } } } } } } }, "/orgs/{org_guid}/widgets/revenue/goods": { "get": { "tags": [ "RevenueReportsWidgets" ], "operationId": "GetReportMoneyPurposesReportForGoodsWidget", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "current_period_from", "in": "query", "required": true, "schema": { "type": "string", "description": "current_period_from", "format": "date-time" } }, { "name": "current_period_to", "in": "query", "required": true, "schema": { "type": "string", "description": "current_period_to", "format": "date-time" } }, { "name": "previous_period_from", "in": "query", "required": true, "schema": { "type": "string", "description": "previous_period_from", "format": "date-time" } }, { "name": "previous_period_to", "in": "query", "required": true, "schema": { "type": "string", "description": "previous_period_to", "format": "date-time" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "max_results", "in": "query", "required": true, "schema": { "maximum": 10, "minimum": 1, "type": "integer", "description": "max_results", "format": "int32" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "ef6d481e-9526-4c1e-8c1c-1d4fdc8cbd65" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoneyPurposesReportForGoodsWidget" } } } } } } }, "/auth/send-code-by-phone": { "post": { "tags": [ "Auth" ], "operationId": "SendCodeByPhone", "parameters": [ { "name": "domain", "in": "query", "schema": { "type": "string" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "08f4fe00-9482-4cea-8cfb-36e6799a2b2d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SendCodeByPhoneCredentials" }, "example": {"phone":"79991112233"} }, "application/json": { "schema": { "$ref": "#/components/schemas/SendCodeByPhoneCredentials" }, "example": {"phone":"79991112233"} }, "text/json": { "schema": { "$ref": "#/components/schemas/SendCodeByPhoneCredentials" }, "example": {"phone":"79991112233"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SendCodeByPhoneCredentials" }, "example": {"phone":"79991112233"} } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/auth/send-code-by-username": { "post": { "tags": [ "Auth" ], "operationId": "SendCodeByUsername", "parameters": [ { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "61f7cc90-6ffe-41a5-a0ec-acc7acab5b16" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SendCodeByUsernameCredentials" }, "example": {"full_username":"my_username"} }, "application/json": { "schema": { "$ref": "#/components/schemas/SendCodeByUsernameCredentials" }, "example": {"full_username":"my_username"} }, "text/json": { "schema": { "$ref": "#/components/schemas/SendCodeByUsernameCredentials" }, "example": {"full_username":"my_username"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SendCodeByUsernameCredentials" }, "example": {"full_username":"my_username"} } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/auth/check-phone-availability": { "post": { "tags": [ "Auth" ], "operationId": "CheckPhoneAvailability", "parameters": [ { "name": "phone", "in": "query", "required": true, "schema": { "maxLength": 18, "minLength": 10, "pattern": "((8|\\+7)-?)?\\(?\\d{3,5}\\)?-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}((-?\\d{1})?-?\\d{1})?", "type": "string", "description": "phone" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "6abc4a8a-ea64-40e4-bda1-7ab4587733a3" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/auth/check-phone-registered": { "post": { "tags": [ "Auth" ], "operationId": "CheckPhoneRegistered", "parameters": [ { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "3b5724f9-4d01-40ad-9c21-ab745ccccc07" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CheckPhoneAvailabilityCredentials" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CheckPhoneAvailabilityCredentials" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CheckPhoneAvailabilityCredentials" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CheckPhoneAvailabilityCredentials" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/auth/check-username-availability": { "post": { "tags": [ "Auth" ], "operationId": "CheckUsernameAvailability", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "maxLength": 24, "minLength": 2, "pattern": "^[a-zA-Z0-9_-]{2,24}$", "type": "string", "description": "username" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "1e8310fb-73e1-4a73-8ffc-ceb0f0ab314a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/auth/reset": { "post": { "tags": [ "Auth" ], "operationId": "Reset", "parameters": [ { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "8ea2f3cc-9d03-4bc0-b525-293e262eab3b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResetCredentials" }, "example": {"phone":"79991112233","password":"мой_пароль","confirmation_code":"123456"} }, "application/json": { "schema": { "$ref": "#/components/schemas/ResetCredentials" }, "example": {"phone":"79991112233","password":"мой_пароль","confirmation_code":"123456"} }, "text/json": { "schema": { "$ref": "#/components/schemas/ResetCredentials" }, "example": {"phone":"79991112233","password":"мой_пароль","confirmation_code":"123456"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResetCredentials" }, "example": {"phone":"79991112233","password":"мой_пароль","confirmation_code":"123456"} } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/auth/reset-pincode": { "post": { "tags": [ "Auth" ], "operationId": "ResetPinCode", "parameters": [ { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "cdb8c151-22eb-4081-9e99-f6daba3f79f4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResetPinCodeCredentials" }, "example": {"phone":"79991112233","confirmation_code":"123456"} }, "application/json": { "schema": { "$ref": "#/components/schemas/ResetPinCodeCredentials" }, "example": {"phone":"79991112233","confirmation_code":"123456"} }, "text/json": { "schema": { "$ref": "#/components/schemas/ResetPinCodeCredentials" }, "example": {"phone":"79991112233","confirmation_code":"123456"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResetPinCodeCredentials" }, "example": {"phone":"79991112233","confirmation_code":"123456"} } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/auth/reset-password": { "post": { "tags": [ "Auth" ], "operationId": "ResetPassword", "parameters": [ { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "85752069-0164-4d45-9cc7-840bd1663735" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResetCredentials" }, "example": {"phone":"79991112233","password":"мой_пароль","confirmation_code":"123456"} }, "application/json": { "schema": { "$ref": "#/components/schemas/ResetCredentials" }, "example": {"phone":"79991112233","password":"мой_пароль","confirmation_code":"123456"} }, "text/json": { "schema": { "$ref": "#/components/schemas/ResetCredentials" }, "example": {"phone":"79991112233","password":"мой_пароль","confirmation_code":"123456"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResetCredentials" }, "example": {"phone":"79991112233","password":"мой_пароль","confirmation_code":"123456"} } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/auth/sign-up": { "post": { "tags": [ "Auth" ], "operationId": "SignUp", "parameters": [ { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "81fcd78a-4a4b-41b6-9f0b-c96b310644e6" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SignUpCredentials" }, "example": {"phone":"79991112233","name":"my name","initial_username":"my username","initial_password":"мой пароль","confirmation_code":"123456"} }, "application/json": { "schema": { "$ref": "#/components/schemas/SignUpCredentials" }, "example": {"phone":"79991112233","name":"my name","initial_username":"my username","initial_password":"мой пароль","confirmation_code":"123456"} }, "text/json": { "schema": { "$ref": "#/components/schemas/SignUpCredentials" }, "example": {"phone":"79991112233","name":"my name","initial_username":"my username","initial_password":"мой пароль","confirmation_code":"123456"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SignUpCredentials" }, "example": {"phone":"79991112233","name":"my name","initial_username":"my username","initial_password":"мой пароль","confirmation_code":"123456"} } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAccess" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/auth/sign-in": { "post": { "tags": [ "Auth" ], "operationId": "SignIn", "parameters": [ { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "1ccc84d3-9a71-426d-a0ef-2f415a115f57" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SignInCredentials" }, "example": {"full_username":"my_username","password":"мой_пароль","response_type":"Session"} }, "application/json": { "schema": { "$ref": "#/components/schemas/SignInCredentials" }, "example": {"full_username":"my_username","password":"мой_пароль","response_type":"Session"} }, "text/json": { "schema": { "$ref": "#/components/schemas/SignInCredentials" }, "example": {"full_username":"my_username","password":"мой_пароль","response_type":"Session"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SignInCredentials" }, "example": {"full_username":"my_username","password":"мой_пароль","response_type":"Session"} } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAccess" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/auth/sign-in-by-phone": { "post": { "tags": [ "Auth" ], "operationId": "SignInByPhone", "parameters": [ { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "86703b5e-ed46-4897-946c-78f16b557cfc" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SignInByPhone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SignInByPhone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SignInByPhone" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SignInByPhone" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAccess" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/auth/check-code-by-phone": { "post": { "tags": [ "Auth" ], "operationId": "CheckCodeByPhone", "parameters": [ { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "466c552a-8889-4d75-8989-30fdf0a9f2af" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CheckCodeByPhone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CheckCodeByPhone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CheckCodeByPhone" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CheckCodeByPhone" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/auth/activate-workplace": { "post": { "tags": [ "Auth" ], "operationId": "ActivateWorkplace", "parameters": [ { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "c8105656-5abf-47e5-9ba4-6de2c7d1e9c9" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ActivateWorkplaceCredentials" }, "example": {"activation_code":"123456"} }, "application/json": { "schema": { "$ref": "#/components/schemas/ActivateWorkplaceCredentials" }, "example": {"activation_code":"123456"} }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivateWorkplaceCredentials" }, "example": {"activation_code":"123456"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActivateWorkplaceCredentials" }, "example": {"activation_code":"123456"} } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkplaceAccess" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/orgs/{org_guid}/brands": { "post": { "tags": [ "Brands" ], "operationId": "CreateBrand", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Transaction", "in": "header", "schema": { "type": "string" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "785244c4-5745-4177-9197-4c3bacd07815" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Brand" }, "example": {"name":"мой_бренд","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"a84bf870-0cbd-4089-86f4-b411d543956a","type_of":"Brand"} }, "application/json": { "schema": { "$ref": "#/components/schemas/Brand" }, "example": {"name":"мой_бренд","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"a84bf870-0cbd-4089-86f4-b411d543956a","type_of":"Brand"} }, "text/json": { "schema": { "$ref": "#/components/schemas/Brand" }, "example": {"name":"мой_бренд","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"a84bf870-0cbd-4089-86f4-b411d543956a","type_of":"Brand"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Brand" }, "example": {"name":"мой_бренд","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"a84bf870-0cbd-4089-86f4-b411d543956a","type_of":"Brand"} } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Brand" }, "example": {"name":"мой_бренд","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"667fdec3-7ffe-4f1f-b438-0a2cdb2e2e4b","type_of":"Brand"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "get": { "tags": [ "Brands" ], "operationId": "ListBrand", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: name, tagline, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/BrandOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "e0fb7277-cd3e-4d1d-a100-1ae3eab2e58a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/brands/{brand_guid}": { "get": { "tags": [ "Brands" ], "operationId": "GetBrandById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "brand_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "085ae4b8-5614-4a82-9b5c-f2d542233c21" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Brand" }, "example": {"name":"мой_бренд","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"24fb3362-9f16-43b0-9c92-3c93f9025d26","type_of":"Brand"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "Brands" ], "operationId": "UpdateBrand", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "brand_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Transaction", "in": "header", "schema": { "type": "string" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "77a82287-7b91-4c00-94f5-5f0842b4aa63" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "Brands" ], "operationId": "DeleteBrand", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "brand_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Transaction", "in": "header", "schema": { "type": "string" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "5de7ce2b-6665-4f34-957b-9dc77c662015" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/brands/{brand_guid}:unarchive": { "post": { "tags": [ "Brands" ], "operationId": "RestoreBrand", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "brand_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Transaction", "in": "header", "schema": { "type": "string" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "36275e30-48f1-44d3-bf49-9a6aa886a715" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/deals/sales/{deal_guid}/sessions/direct-correction": { "post": { "tags": [ "DirectCorrectionSaleSessions" ], "operationId": "CreateDirectCorrectionSaleSession", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "c169e265-16be-4eb3-8fb1-5dd2e4136c47" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DirectCorrectionSaleSession" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DirectCorrectionSaleSession" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DirectCorrectionSaleSession" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DirectCorrectionSaleSession" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectCorrectionSaleSession" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/deals/sales/{deal_guid}/sessions/direct-correction/{session_guid}": { "get": { "tags": [ "DirectCorrectionSaleSessions" ], "operationId": "ReadDirectCorrectionSaleSessionById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "session_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "expand" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "f50c9e3f-45a2-4811-ada4-c17bbc280b03" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectCorrectionSaleSession" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "DirectCorrectionSaleSessions" ], "operationId": "UpdateDirectCorrectionSaleSession", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "session_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "c1730fbf-9360-4e0f-9ac9-cdd354b439c4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "delete": { "tags": [ "DirectCorrectionSaleSessions" ], "operationId": "DeleteDirectCorrectionSaleSession", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "session_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "9030e2b4-ff27-43a0-90c0-b2e72d0a5c8a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/deals/sales/{deal_guid}/sessions/direct-correction/{session_guid}:unarchive": { "post": { "tags": [ "DirectCorrectionSaleSessions" ], "operationId": "RestoreDirectCorrectionSaleSession", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "session_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "3cdac6ac-fc4e-445e-b148-a9d099e75b75" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/deals/sales/{deal_guid}/sessions/direct": { "post": { "tags": [ "DirectSaleSessions" ], "operationId": "CreateDirectSaleSession", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "85b500b3-2927-4827-aed4-8009b9de2a3d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DirectSaleSession" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DirectSaleSession" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DirectSaleSession" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DirectSaleSession" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectSaleSession" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/deals/sales/{deal_guid}/sessions/direct/{session_guid}": { "get": { "tags": [ "DirectSaleSessions" ], "operationId": "GetDirectSaleSessionById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "session_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "expand" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "43d094ec-398c-4d90-982e-e76017b091a1" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectSaleSession" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "DirectSaleSessions" ], "operationId": "UpdateDirectSaleSession", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "session_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "38cc9381-2fb3-4d7f-bc01-25fff00e50ca" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "delete": { "tags": [ "DirectSaleSessions" ], "operationId": "DeleteDirectSaleSession", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "session_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "62bde244-4d14-4810-9e55-5d27059e13a7" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/deals/sales/{deal_guid}/sessions/direct/{session_guid}:unarchive": { "post": { "tags": [ "DirectSaleSessions" ], "operationId": "RestoreDirectSaleSession", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "session_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "684e28cc-64ae-4c21-b381-4aca56a0ed28" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/employees": { "post": { "tags": [ "Employees" ], "operationId": "CreateEmployee", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "392e25b6-3c93-40b5-80b4-caf5cdc0f692" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Employee" }, "example": {"name":"Василий Пупкин","username":"vasya_pupkin","phone":"79991112233","role":{"role_type":"BuiltIn","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"00000000-0000-0000-0000-000000000000","type_of":"Role"},"email":"vasya@pupkin.vru","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"9c579a8b-4fe6-40a8-93fb-b268fb018d8b","type_of":"Employee"} }, "application/json": { "schema": { "$ref": "#/components/schemas/Employee" }, "example": {"name":"Василий Пупкин","username":"vasya_pupkin","phone":"79991112233","role":{"role_type":"BuiltIn","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"00000000-0000-0000-0000-000000000000","type_of":"Role"},"email":"vasya@pupkin.vru","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"9c579a8b-4fe6-40a8-93fb-b268fb018d8b","type_of":"Employee"} }, "text/json": { "schema": { "$ref": "#/components/schemas/Employee" }, "example": {"name":"Василий Пупкин","username":"vasya_pupkin","phone":"79991112233","role":{"role_type":"BuiltIn","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"00000000-0000-0000-0000-000000000000","type_of":"Role"},"email":"vasya@pupkin.vru","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"9c579a8b-4fe6-40a8-93fb-b268fb018d8b","type_of":"Employee"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Employee" }, "example": {"name":"Василий Пупкин","username":"vasya_pupkin","phone":"79991112233","role":{"role_type":"BuiltIn","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"00000000-0000-0000-0000-000000000000","type_of":"Role"},"email":"vasya@pupkin.vru","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"9c579a8b-4fe6-40a8-93fb-b268fb018d8b","type_of":"Employee"} } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" }, "example": {"name":"Василий Пупкин","username":"vasya_pupkin","phone":"79991112233","role":{"role_type":"BuiltIn","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"00000000-0000-0000-0000-000000000000","type_of":"Role"},"email":"vasya@pupkin.vru","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"e83d2228-7bbe-445d-bdb3-25666b11c179","type_of":"Employee"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "get": { "tags": [ "Employees" ], "operationId": "ListEmployee", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: name, username, phone, inn, email, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/EmployeeOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "853e5743-47d4-41a7-9e91-0e2ce07772a8" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeePage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager", "cashier", "courier" ] } ] } }, "/orgs/{org_guid}/employees/{employee_guid}": { "get": { "tags": [ "Employees" ], "operationId": "GetEmployeeById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "eca2edb6-758b-4cbc-9fd9-fbb07d0ea1df" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" }, "example": {"name":"Василий Пупкин","username":"vasya_pupkin","phone":"79991112233","role":{"role_type":"BuiltIn","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"00000000-0000-0000-0000-000000000000","type_of":"Role"},"email":"vasya@pupkin.vru","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"c5b8168f-b877-4467-8ec2-920548d75bf1","type_of":"Employee"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager", "cashier", "courier" ] } ] }, "patch": { "tags": [ "Employees" ], "operationId": "UpdateEmployee", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "b03c4d50-30ee-4a65-845e-f3c0ca254eab" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "Employees" ], "operationId": "DeleteEmployee", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "b66e9521-f0af-4995-9740-9860b71ce7ec" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/employees/{employee_guid}:unarchive": { "post": { "tags": [ "Employees" ], "operationId": "RestoreEmployee", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "0ed17e3d-d090-4fe6-b61f-5c7638dfd405" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/employees/{employee_guid}:reset-credentials": { "post": { "tags": [ "Employees" ], "operationId": "ResetCredentialsOfEmployee", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "41db301d-1489-44ff-af67-b6109f07e612" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/employees/{employee_guid}:reset-pincode": { "post": { "tags": [ "Employees" ], "operationId": "ResetPinCodeOfEmployee", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "44ab64e3-0731-4532-a298-693e07714deb" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/employees/{employee_guid}:reset-password": { "post": { "tags": [ "Employees" ], "operationId": "ResetPasswordOfEmployee", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "60d36183-2290-4244-b8c8-c51b62f1e2a3" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordResponse" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/legal-entities": { "post": { "tags": [ "LegalEntities" ], "operationId": "CreateLegalEntity", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "36b972db-2b14-4582-bf9f-d9f2a87ce8ba" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LegalEntity" }, "example": {"juridical_name":"ООО \"Рога и копыта\"","juridical_address":"ул. пушкина, д. 1","inn":"123456789012","tax_systems":[],"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"e9eb9a93-2f78-4b6d-b7f1-a3a692c35eec","type_of":"LegalEntity"} }, "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity" }, "example": {"juridical_name":"ООО \"Рога и копыта\"","juridical_address":"ул. пушкина, д. 1","inn":"123456789012","tax_systems":[],"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"e9eb9a93-2f78-4b6d-b7f1-a3a692c35eec","type_of":"LegalEntity"} }, "text/json": { "schema": { "$ref": "#/components/schemas/LegalEntity" }, "example": {"juridical_name":"ООО \"Рога и копыта\"","juridical_address":"ул. пушкина, д. 1","inn":"123456789012","tax_systems":[],"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"e9eb9a93-2f78-4b6d-b7f1-a3a692c35eec","type_of":"LegalEntity"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LegalEntity" }, "example": {"juridical_name":"ООО \"Рога и копыта\"","juridical_address":"ул. пушкина, д. 1","inn":"123456789012","tax_systems":[],"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"e9eb9a93-2f78-4b6d-b7f1-a3a692c35eec","type_of":"LegalEntity"} } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity" }, "example": {"juridical_name":"ООО \"Рога и копыта\"","juridical_address":"ул. пушкина, д. 1","inn":"123456789012","tax_systems":[],"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"453ef4e5-7327-48b9-9c4a-dad013f22e7a","type_of":"LegalEntity"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "get": { "tags": [ "LegalEntities" ], "operationId": "ListLegalEntity", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: juridical_name, juridical_address, inn, kpp, ogrn, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/LegalEntityOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "a658338c-64cf-435b-a5ec-d35e59ef049a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntityPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/legal-entities/{entity_guid}": { "get": { "tags": [ "LegalEntities" ], "operationId": "ReadLegalEntity", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "entity_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "89971ed4-85e4-488b-8e3e-fe253ad48800" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalEntity" }, "example": {"juridical_name":"ООО \"Рога и копыта\"","juridical_address":"ул. пушкина, д. 1","inn":"123456789012","tax_systems":[],"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"e8f9633f-d157-4f57-8407-c0f1e65e5c50","type_of":"LegalEntity"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "LegalEntities" ], "operationId": "UpdateLegalEntity", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "entity_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "7c673c10-ce78-4829-b730-ce9b4ed405a4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "LegalEntities" ], "operationId": "DeleteLegalEntity", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "entity_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "9d90739a-0ff2-4d6a-bf9c-15a5f6849b04" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/legal-entities/{entity_guid}:unarchive": { "post": { "tags": [ "LegalEntities" ], "operationId": "RestoreLegalEntity", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "entity_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "99a1ba91-a473-40fe-a5bb-19f6df96db95" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/reports/operation/transaction": { "get": { "tags": [ "OperationsReport" ], "operationId": "GetReportReportTransactionItem", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "description": "date_from", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "description": "date_to", "format": "date-time" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "1ffeaf6e-8588-46fd-b38b-55c821428037" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTransactionItemPage" } } } } } } }, "/orgs/{org_guid}/reports/operation/fiscal": { "get": { "tags": [ "OperationsReport" ], "operationId": "GetReportReportFiscalDocumentItem", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "description": "date_from", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "description": "date_to", "format": "date-time" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "a210368d-9629-4737-93d6-418cac6ac659" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportFiscalDocumentItemPage" } } } } } } }, "/orgs/{org_guid}/reports/operation/money": { "get": { "tags": [ "OperationsReport" ], "operationId": "GetReportReportMoneyItem", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "description": "date_from", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "description": "date_to", "format": "date-time" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "8821d170-b6ec-4339-8169-b275edc056f6" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportMoneyItemPage" } } } } } } }, "/orgs/{org_guid}/reports/operation/paymentrefund": { "get": { "tags": [ "OperationsReport" ], "operationId": "GetReportReportPaymentAndRefundItem", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "description": "date_from", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "description": "date_to", "format": "date-time" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "521f92b8-aad4-458c-9c3b-2370a466d275" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportPaymentAndRefundItemPage" } } } } } } }, "/orgs/{org_guid}/reports/operation/combined": { "get": { "tags": [ "OperationsReport" ], "operationId": "GetReportReportCombinedItem", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "description": "date_from", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "description": "date_to", "format": "date-time" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "54e8bb72-f931-44af-b0c5-767502ac6f78" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCombinedItemPage" } } } } } } }, "/orgs/{org_guid}/reports/nomenclature/results": { "get": { "tags": [ "OperationsReport" ], "operationId": "GetReportReportNomenclatureResultItem", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "description": "date_from", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "description": "date_to", "format": "date-time" } }, { "name": "outlet_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "employee_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "employee_guid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "5ddc1d4a-5a69-4e23-8fd8-149261236503" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureResultItemPage" } } } } } } }, "/orgs/{org_guid}/reports/nomenclature/balance/results": { "get": { "tags": [ "OperationsReport" ], "operationId": "GetReportReportNomenclatureBalanceResultItem", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "description": "date_from", "format": "date-time" } }, { "name": "good_category_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "good_category_guid" } }, { "name": "outlet_guid", "in": "query", "schema": { "type": "string", "description": "outlet_guid", "format": "uuid" } }, { "name": "warehouse_guid", "in": "query", "schema": { "type": "string", "description": "warehouse_guid", "format": "uuid" } }, { "name": "balance_type", "in": "query", "schema": { "$ref": "#/components/schemas/ReportNomenclatureBalanceType" } }, { "name": "balance_value", "in": "query", "schema": { "type": "number", "description": "balance_value", "format": "double" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "190b7695-b76a-4d16-999c-c0ba1c36096d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureBalanceResultItemPage" } } } } } } }, "/orgs/{org_guid}/reports/nomenclature/profit/results": { "get": { "tags": [ "OperationsReport" ], "operationId": "GetReportReportNomenclatureProfitResultItem", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "description": "date_from", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "description": "date_to", "format": "date-time" } }, { "name": "good_category_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "good_category_guid" } }, { "name": "outlet_guid", "in": "query", "schema": { "type": "string", "description": "outlet_guid", "format": "uuid" } }, { "name": "warehouse_guid", "in": "query", "schema": { "type": "string", "description": "warehouse_guid", "format": "uuid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "652f3d48-f3bd-4ad8-b5f6-33436003ad5d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureProfitResultItemPage" } } } } } } }, "/orgs/{org_guid}/options": { "post": { "tags": [ "OrganizationOptions" ], "operationId": "CreateOrganizationOption", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "c962cc77-81fb-4813-a7ae-99a1d85dab8e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Option" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Option" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Option" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Option" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Option" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "get": { "tags": [ "OrganizationOptions" ], "operationId": "ListOrganizationOption", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "key", "in": "query", "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: key, value, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/DefaultOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "2650e3ab-c066-44da-8bb2-b9b250123022" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/options/{option_guid}": { "get": { "tags": [ "OrganizationOptions" ], "operationId": "GetOrganizationOptionById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "option_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "6aee78a7-b2c8-41b5-87a6-6baae5a94f99" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Option" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "patch": { "tags": [ "OrganizationOptions" ], "operationId": "UpdateOrganizationOption", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "option_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Transaction", "in": "header", "schema": { "type": "string" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "e38fad71-616b-40c5-ac88-e493ca2ac158" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "OrganizationOptions" ], "operationId": "DeleteOrganizationOption", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "option_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Transaction", "in": "header", "schema": { "type": "string" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "1dbcdc20-0733-437a-a1da-52fba9a62c7c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs": { "post": { "tags": [ "Organizations" ], "operationId": "CreateOrganization", "parameters": [ { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "41539045-c152-4a64-8e5c-457a51616f9b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Organization" }, "example": {"name":"my_name","alias":"my_organization","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"7992c718-9788-446e-a6b5-76e665a0ef05","type_of":"Organization"} }, "application/json": { "schema": { "$ref": "#/components/schemas/Organization" }, "example": {"name":"my_name","alias":"my_organization","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"7992c718-9788-446e-a6b5-76e665a0ef05","type_of":"Organization"} }, "text/json": { "schema": { "$ref": "#/components/schemas/Organization" }, "example": {"name":"my_name","alias":"my_organization","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"7992c718-9788-446e-a6b5-76e665a0ef05","type_of":"Organization"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Organization" }, "example": {"name":"my_name","alias":"my_organization","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"7992c718-9788-446e-a6b5-76e665a0ef05","type_of":"Organization"} } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" }, "example": {"name":"my_name","alias":"my_organization","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"b2b08ab0-05b2-4ec3-b3d8-71030c0636d5","type_of":"Organization"} } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner" ] } ] }, "get": { "tags": [ "Organizations" ], "operationId": "ListOrganization", "parameters": [ { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: name, alias, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/OrganizationOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "b4771be6-e5b8-44d9-b555-0120cf961f77" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationPage" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager", "cashier", "courier", "guest" ] } ] } }, "/orgs/{org_guid}": { "get": { "tags": [ "Organizations" ], "operationId": "GetOrganizationById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "86ae521d-bc35-41a1-a255-2073de6ea6c7" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" }, "example": {"name":"my_name","alias":"my_organization","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"ecab1b74-c302-4a9d-afab-9df294c3f3f1","type_of":"Organization"} } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager", "cashier", "courier", "guest" ] } ] }, "patch": { "tags": [ "Organizations" ], "operationId": "UpdateOrganization", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "5d595f9e-1d13-46bc-8b3e-dcb58c4165ba" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "Organizations" ], "operationId": "DeleteOrganization", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "dadcab21-07a9-4660-a0c1-0605f2927272" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner" ] } ] } }, "/orgs/{org_guid}:unarchive": { "post": { "tags": [ "Organizations" ], "operationId": "RestoreOrganization", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Transaction", "in": "header", "schema": { "type": "string" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "9292e2c0-5819-4cd6-a259-6b5c46c278ad" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner" ] } ] } }, "/orgs:check-alias-availability": { "post": { "tags": [ "Organizations" ], "operationId": "CheckOrganizationAliasAvailability", "parameters": [ { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "f07cd2ab-dc6f-4fd7-9761-6ab44143d0a4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OrganizationAliasAvailability" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationAliasAvailability" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationAliasAvailability" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrganizationAliasAvailability" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/orgs/{org_guid}/reports/revenue/periods": { "get": { "tags": [ "RevenueReports" ], "operationId": "GetReportRevenueByPeriodsReportItem", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "processed_at_from", "in": "query", "schema": { "type": "string", "description": "processed_at_from", "format": "date-time" } }, { "name": "processed_at_to", "in": "query", "schema": { "type": "string", "description": "processed_at_to", "format": "date-time" } }, { "name": "revenueByPeriodsType", "in": "query", "schema": { "$ref": "#/components/schemas/RevenueByPeriodsType" } }, { "name": "outlet_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "employee_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "employee_guid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "3d382857-d9ff-45ff-a01b-b8c6850d1975" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueSummaryRevenueByPeriodsReportItemPageSummary" } } } } } } }, "/orgs/{org_guid}/reports/revenue/outletsperiods": { "get": { "tags": [ "RevenueReports" ], "operationId": "GetReportRevenueByOutletsPeriodsReportItem", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "processed_at_from", "in": "query", "schema": { "type": "string", "description": "processed_at_from", "format": "date-time" } }, { "name": "processed_at_to", "in": "query", "schema": { "type": "string", "description": "processed_at_to", "format": "date-time" } }, { "name": "revenueByPeriodsType", "in": "query", "schema": { "$ref": "#/components/schemas/RevenueByPeriodsType" } }, { "name": "outlet_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "employee_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "employee_guid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "e5a889dc-d601-4d70-870f-1f3dd1dd3fd3" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueSummaryRevenueByOutletsPeriodsReportItemPageSummary" } } } } } } }, "/orgs/{org_guid}/reports/revenue/employeesperiods": { "get": { "tags": [ "RevenueReports" ], "operationId": "GetReportRevenueByEmployeesPeriodsReportItem", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "processed_at_from", "in": "query", "schema": { "type": "string", "description": "processed_at_from", "format": "date-time" } }, { "name": "processed_at_to", "in": "query", "schema": { "type": "string", "description": "processed_at_to", "format": "date-time" } }, { "name": "revenueByPeriodsType", "in": "query", "schema": { "$ref": "#/components/schemas/RevenueByPeriodsType" } }, { "name": "outlet_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "employee_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "employee_guid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "1656058a-9856-4aa8-9ce1-982a86974916" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueSummaryRevenueByEmployeesPeriodsReportItemPageSummary" } } } } } } }, "/orgs/{org_guid}/reports/revenue/outletsandperiods": { "get": { "tags": [ "RevenueReports" ], "operationId": "GetReportRevenueByPeriodsAndOutletsReportItem", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "processed_at_from", "in": "query", "schema": { "type": "string", "description": "processed_at_from", "format": "date-time" } }, { "name": "processed_at_to", "in": "query", "schema": { "type": "string", "description": "processed_at_to", "format": "date-time" } }, { "name": "revenueByPeriodsType", "in": "query", "schema": { "$ref": "#/components/schemas/RevenueByPeriodsType" } }, { "name": "outlet_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "employee_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "employee_guid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "c0c10766-a4d7-4626-9106-0f90fb4ff6ed" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueSummaryRevenueByPeriodsAndOutletsReportItemPageSummary" } } } } } } }, "/orgs/{org_guid}/reports/revenue/employeesandperiods": { "get": { "tags": [ "RevenueReports" ], "operationId": "GetReportRevenueByPeriodsAndEmployeesReportItem", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "processed_at_from", "in": "query", "schema": { "type": "string", "description": "processed_at_from", "format": "date-time" } }, { "name": "processed_at_to", "in": "query", "schema": { "type": "string", "description": "processed_at_to", "format": "date-time" } }, { "name": "revenueByPeriodsType", "in": "query", "schema": { "$ref": "#/components/schemas/RevenueByPeriodsType" } }, { "name": "outlet_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "employee_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "employee_guid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "ae2979fd-f2b0-4136-aaee-6eb3180c369a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueSummaryRevenueByPeriodsAndEmployeesReportItemPageSummary" } } } } } } }, "/orgs/{org_guid}/reports/revenue/outlet": { "get": { "tags": [ "RevenueReports" ], "operationId": "GetReportRevenueByOutletsReportItem", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "processed_at_from", "in": "query", "schema": { "type": "string", "description": "processed_at_from", "format": "date-time" } }, { "name": "processed_at_to", "in": "query", "schema": { "type": "string", "description": "processed_at_to", "format": "date-time" } }, { "name": "outlet_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "c6017bbf-7917-4885-a450-7cc90a5aef70" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueSummaryRevenueByOutletsReportItemPageSummary" } } } } } } }, "/orgs/{org_guid}/reports/revenue/employee": { "get": { "tags": [ "RevenueReports" ], "operationId": "GetReportRevenueByEmployeesReportItem", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "processed_at_from", "in": "query", "schema": { "type": "string", "description": "processed_at_from", "format": "date-time" } }, { "name": "processed_at_to", "in": "query", "schema": { "type": "string", "description": "processed_at_to", "format": "date-time" } }, { "name": "employee_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "employee_guid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "3d4dd1a7-94c9-4d12-9af6-e72d31fa6ebd" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueSummaryRevenueByEmployeesReportItemPageSummary" } } } } } } }, "/orgs/{org_guid}/deals/sales/{deal_guid}/sessions/reversal-correction": { "post": { "tags": [ "ReversalCorrectionSaleSessions" ], "operationId": "CreateReversalCorrectionSaleSession", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "3f63c850-35d2-41d2-80c8-2b79a7cec5a3" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReversalCorrectionSaleSession" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReversalCorrectionSaleSession" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReversalCorrectionSaleSession" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReversalCorrectionSaleSession" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReversalCorrectionSaleSession" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/deals/sales/{deal_guid}/sessions/reversal-correction/{session_guid}": { "get": { "tags": [ "ReversalCorrectionSaleSessions" ], "operationId": "GetReversalCorrectionSaleSessionById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "session_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "expand" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "df52bcda-912a-4ec8-9f61-01f050641b80" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReversalCorrectionSaleSession" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "ReversalCorrectionSaleSessions" ], "operationId": "UpdateReversalCorrectionSaleSession", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "session_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "45da36f0-6f0d-4df5-be9c-c3f562049552" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "delete": { "tags": [ "ReversalCorrectionSaleSessions" ], "operationId": "DeleteReversalCorrectionSaleSession", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "session_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "427ddfde-2b71-40c3-8e7e-f2a35d35c047" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/deals/sales/{deal_guid}/sessions/reversal-correction/{session_guid}:unarchive": { "post": { "tags": [ "ReversalCorrectionSaleSessions" ], "operationId": "RestoreReversalCorrectionSaleSession", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "session_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "0444bbe2-b83b-4ade-842f-398f64e79886" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/deals/sales/{deal_guid}/sessions/reversal": { "post": { "tags": [ "ReversalSaleSessions" ], "operationId": "CreateReversalSaleSession", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "889f3502-8ef3-4ca9-88f6-bf5760c26e65" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReversalSaleSession" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReversalSaleSession" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReversalSaleSession" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReversalSaleSession" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReversalSaleSession" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/deals/sales/{deal_guid}/sessions/reversal/{session_guid}": { "get": { "tags": [ "ReversalSaleSessions" ], "operationId": "GetReversalSaleSessionById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "session_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "expand" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "caf3486e-a4dc-42cd-b648-b03673078803" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReversalSaleSession" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "ReversalSaleSessions" ], "operationId": "UpdateReversalSaleSession", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "session_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "0d2b1df7-f073-49d3-b58f-88a680b7bad5" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "delete": { "tags": [ "ReversalSaleSessions" ], "operationId": "DeleteReversalSaleSession", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "session_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "476edbfa-0fc8-484b-92c8-c3f7041bd39b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/deals/sales/{deal_guid}/sessions/reversal/{session_guid}:unarchive": { "post": { "tags": [ "ReversalSaleSessions" ], "operationId": "RestoreReversalSaleSession", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "session_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "fad04f71-cc72-4d78-aff3-09d355f957fe" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/roles": { "get": { "tags": [ "Roles" ], "operationId": "ListRoles", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: name, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/DefaultOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "57e993a6-f4ce-49d1-8711-778e5a32ffd4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RolePage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager", "cashier", "courier" ] } ] } }, "/orgs/{org_guid}/roles/access": { "get": { "tags": [ "Roles" ], "operationId": "ListRoleAccess", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "role_guid", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "0ca91e70-9290-406b-88b8-d6d856dd8083" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAccessGroup" } } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/deals/sales/{deal_guid}/sessions": { "get": { "tags": [ "SaleSessions" ], "operationId": "ListISaleSession", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "expand" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/DefaultOrderings" } }, { "name": "query", "in": "query", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "total_amount_from", "in": "query", "schema": { "type": "integer", "description": "total_amount_from", "format": "int64" } }, { "name": "total_amount_to", "in": "query", "schema": { "type": "integer", "description": "total_amount_to", "format": "int64" } }, { "name": "total_quantity_from", "in": "query", "schema": { "type": "number", "description": "total_quantity_from", "format": "double" } }, { "name": "total_quantity_to", "in": "query", "schema": { "type": "number", "description": "total_quantity_to", "format": "double" } }, { "name": "type", "in": "query", "schema": { "pattern": "(DirectSaleSession|DirectCorrectionSaleSession|ReversalSaleSession|ReversalCorrectionSaleSession)", "type": "string", "description": "type" } }, { "name": "outlet_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "workplace_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "workplace_guid" } }, { "name": "opened_by_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "opened_by_guid" } }, { "name": "transaction_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "transaction_guid" } }, { "name": "fiscal_document_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "fiscal_document_guid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "879b9924-518c-434f-b571-3ee3c656c3a2" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISaleSessionPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/deals/sales/{deal_guid}/sessions/*/{session_guid}": { "get": { "tags": [ "SaleSessions" ], "operationId": "GetISaleSessionById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "session_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "3304f13a-7782-46da-9985-bd39d4dd5c44" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISaleSession" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/uoms": { "post": { "tags": [ "Uoms" ], "operationId": "CreateUom", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "4d2b2223-c6ca-4fc8-abfd-9cd3f0ff8881" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Uom" }, "example": {"name":"Иена","symbol":"¥","is_fractional":false,"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"778a5809-ec56-423f-b519-0defd5113758","type_of":"Uom"} }, "application/json": { "schema": { "$ref": "#/components/schemas/Uom" }, "example": {"name":"Иена","symbol":"¥","is_fractional":false,"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"778a5809-ec56-423f-b519-0defd5113758","type_of":"Uom"} }, "text/json": { "schema": { "$ref": "#/components/schemas/Uom" }, "example": {"name":"Иена","symbol":"¥","is_fractional":false,"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"778a5809-ec56-423f-b519-0defd5113758","type_of":"Uom"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Uom" }, "example": {"name":"Иена","symbol":"¥","is_fractional":false,"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"778a5809-ec56-423f-b519-0defd5113758","type_of":"Uom"} } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Uom" }, "example": {"name":"Иена","symbol":"¥","is_fractional":false,"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"87ee3a03-e360-46c9-8e67-4ffc3fc787d7","type_of":"Uom"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "delete": { "tags": [ "Uoms" ], "operationId": "DeleteAllUoms", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "ae1c8220-fe93-419a-88eb-c445217318f0" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "get": { "tags": [ "Uoms" ], "operationId": "ListUom", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: name, symbol, code_ru_okei, code_unece, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/UomOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "204c7958-7151-4f9e-a5ab-c0d26077dad2" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UomPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager", "cashier", "courier" ] } ] } }, "/orgs/{org_guid}/uoms/{uom_guid}": { "get": { "tags": [ "Uoms" ], "operationId": "GetUomById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "uom_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "24ad2bb0-74a4-4740-a80b-1e2cf7f6392b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Uom" }, "example": {"name":"Иена","symbol":"¥","is_fractional":false,"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"0961edcc-bafa-4b07-b344-6a0c7207130d","type_of":"Uom"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager", "cashier", "courier" ] } ] }, "patch": { "tags": [ "Uoms" ], "operationId": "UpdateUom", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "uom_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "186f88a0-3ac8-4249-87b5-9f510af083a0" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "delete": { "tags": [ "Uoms" ], "operationId": "DeleteUom", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "uom_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "0f04dcbf-63bd-41a4-a1a8-8abc208e2ab2" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/uoms/{uom_guid}:unarchive": { "post": { "tags": [ "Uoms" ], "operationId": "UomRestore", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "uom_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "dd9a8621-7b66-4677-a4d7-5a2f5e1d2faa" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/workplaces": { "post": { "tags": [ "Workplaces" ], "operationId": "CreateWorkplace", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "13f4f14f-a545-4582-8c68-90810804dae5" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Workplace" }, "example": {"workplace_type":"Stationary","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"191bd08d-2e04-4268-8da1-2233b40c7ea1","type_of":"Workplace"} }, "application/json": { "schema": { "$ref": "#/components/schemas/Workplace" }, "example": {"workplace_type":"Stationary","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"191bd08d-2e04-4268-8da1-2233b40c7ea1","type_of":"Workplace"} }, "text/json": { "schema": { "$ref": "#/components/schemas/Workplace" }, "example": {"workplace_type":"Stationary","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"191bd08d-2e04-4268-8da1-2233b40c7ea1","type_of":"Workplace"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Workplace" }, "example": {"workplace_type":"Stationary","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"191bd08d-2e04-4268-8da1-2233b40c7ea1","type_of":"Workplace"} } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workplace" }, "example": {"workplace_type":"Stationary","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"c17dd811-95f6-4c39-87f4-c1e5797cb53e","type_of":"Workplace"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "get": { "tags": [ "Workplaces" ], "operationId": "ListWorkplace", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: number, name, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/WorkplaceOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "67ab5359-d0ca-48e7-94f9-9309e9f11323" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkplacePage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/workplaces/{workplace_guid}": { "get": { "tags": [ "Workplaces" ], "operationId": "GetWorkplaceById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workplace_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "7ffaec8e-39f2-4b2d-9570-5b91efbf2d55" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workplace" }, "example": {"workplace_type":"Stationary","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"cbe409b1-64c2-4139-9084-35f5df0bc42d","type_of":"Workplace"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "Workplaces" ], "operationId": "UpdateWorkplace", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workplace_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "62ca4a1f-20f2-46df-9a8a-785b1e0516cc" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "Workplaces" ], "operationId": "DeleteWorkplace", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workplace_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "376f565d-893d-4141-ba27-792318e400ef" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/workplaces/{workplace_guid}:unarchive": { "post": { "tags": [ "Workplaces" ], "operationId": "RestoreWorkplace", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workplace_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "69b250db-a6eb-4d1b-9fa6-2f3d97f26008" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/workplaces/{workplace_guid}:generate-activation-code": { "post": { "tags": [ "Workplaces" ], "operationId": "GenerateActivationCodeOfWorkplace", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workplace_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "cc26bddf-0be4-44cb-b2d1-3751825c0be3" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GenerateActivationCodeParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GenerateActivationCodeParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenerateActivationCodeParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GenerateActivationCodeParams" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratedActivationCode" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/workplaces/{workplace_guid}:deactivate": { "post": { "tags": [ "Workplaces" ], "operationId": "DeactivateWorkplace", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workplace_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "6273b2d7-6697-4898-b1e6-ac3366e60098" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/profile/invoices": { "get": { "tags": [ "Invoices" ], "operationId": "ListInvoices", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "49e6c777-c4c7-421e-9533-0a33845928f9" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/profile/invoices/{invoice_guid}": { "get": { "tags": [ "Invoices" ], "operationId": "GetInvoice", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "invoice_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "fb40e8e3-03ac-43ab-b435-1f0562832c46" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/profile/subscriptions/products": { "get": { "tags": [ "Subscriptions" ], "operationId": "ListSubscriptionProducts", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "6f7903cf-419f-4706-88da-4abbe1ab79fa" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionProduct" } } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/profile/subscriptions/products/{product_guid}:calculate-license": { "post": { "tags": [ "Subscriptions" ], "operationId": "SubscriptionCalculateLicense", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "product_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "5ca0c3c2-aa1e-423e-bfd9-212f346b0cee" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SubscriptionLicenseApplication" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionLicenseApplication" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubscriptionLicenseApplication" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SubscriptionLicenseApplication" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionLicenseOffer" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/profile/subscriptions/products/{product_guid}:create-invoice": { "post": { "tags": [ "Subscriptions" ], "operationId": "SubscriptionCreateInvoice", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "product_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "971018c9-18c0-44ba-bd49-d2ca6e65b444" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SubscriptionLicenseApplication" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionLicenseApplication" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubscriptionLicenseApplication" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SubscriptionLicenseApplication" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/outlets": { "post": { "tags": [ "Outlets" ], "operationId": "CreateOutlet", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "5a27d136-138d-409c-8e0c-ec27d9dad7b8" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Outlet" }, "example": {"name":"Планета обуви","address":"ул. пушкина, д. 1","legal_entity":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"LegalEntity"},"online_type":"Offline","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"6e60bf46-50a3-4352-818a-e050c6eae33f","type_of":"Outlet"} }, "application/json": { "schema": { "$ref": "#/components/schemas/Outlet" }, "example": {"name":"Планета обуви","address":"ул. пушкина, д. 1","legal_entity":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"LegalEntity"},"online_type":"Offline","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"6e60bf46-50a3-4352-818a-e050c6eae33f","type_of":"Outlet"} }, "text/json": { "schema": { "$ref": "#/components/schemas/Outlet" }, "example": {"name":"Планета обуви","address":"ул. пушкина, д. 1","legal_entity":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"LegalEntity"},"online_type":"Offline","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"6e60bf46-50a3-4352-818a-e050c6eae33f","type_of":"Outlet"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Outlet" }, "example": {"name":"Планета обуви","address":"ул. пушкина, д. 1","legal_entity":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"LegalEntity"},"online_type":"Offline","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"6e60bf46-50a3-4352-818a-e050c6eae33f","type_of":"Outlet"} } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Outlet" }, "example": {"name":"Планета обуви","address":"ул. пушкина, д. 1","legal_entity":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"LegalEntity"},"online_type":"Offline","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"285bb624-950f-496e-a79b-e0e89bb70e16","type_of":"Outlet"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "get": { "tags": [ "Outlets" ], "operationId": "ListOutlet", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: name, address, outlet_permissions, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/OutletOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "OnlineType", "in": "query", "schema": { "$ref": "#/components/schemas/PTOnlineType" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "f8608e6d-25bc-4060-ac62-82e5bdbee582" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutletPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/outlets/{outlet_guid}": { "get": { "tags": [ "Outlets" ], "operationId": "GetOutletById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "outlet_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "2391f511-5e1e-4dc3-8c94-56e37add724d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Outlet" }, "example": {"name":"Планета обуви","address":"ул. пушкина, д. 1","legal_entity":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"LegalEntity"},"online_type":"Offline","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"5b33a018-1ffb-4509-8987-e5692c06bdab","type_of":"Outlet"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "Outlets" ], "operationId": "UpdateOutlet", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "outlet_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "b9075e31-1370-4556-a2c6-4ac3a38f1b6d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "Outlets" ], "operationId": "DeleteOutlet", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "outlet_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "129d991a-740a-4ff9-9d21-3f3d898c3bfa" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/outlets/{outlet_guid}:unarchive": { "post": { "tags": [ "Outlets" ], "operationId": "RestoreOutlet", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "outlet_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "b8f11b7f-aaa2-4ea6-8081-7bd3da501593" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/goods-categories": { "post": { "tags": [ "GoodsCategories" ], "operationId": "CreateGoodsCategory", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "5ebc8fdd-6160-400d-9de2-4f5b2beb8355" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GoodsCategory" }, "example": {"name":"моя категория товаров","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"e47e3070-c0ba-4e34-9001-66b6ef0eaa6b","type_of":"GoodsCategory"} }, "application/json": { "schema": { "$ref": "#/components/schemas/GoodsCategory" }, "example": {"name":"моя категория товаров","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"e47e3070-c0ba-4e34-9001-66b6ef0eaa6b","type_of":"GoodsCategory"} }, "text/json": { "schema": { "$ref": "#/components/schemas/GoodsCategory" }, "example": {"name":"моя категория товаров","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"e47e3070-c0ba-4e34-9001-66b6ef0eaa6b","type_of":"GoodsCategory"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GoodsCategory" }, "example": {"name":"моя категория товаров","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"e47e3070-c0ba-4e34-9001-66b6ef0eaa6b","type_of":"GoodsCategory"} } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoodsCategory" }, "example": {"name":"моя категория товаров","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"a81f3e0e-48d3-42b4-ae6f-de7bfbb83ebe","type_of":"GoodsCategory"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "delete": { "tags": [ "GoodsCategories" ], "operationId": "DeleteAllGoodsCategory", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "ceeec43c-2669-49e8-8254-e9b171267428" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "get": { "tags": [ "GoodsCategories" ], "operationId": "ListGoodsCategory", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: name, description, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/GoodsCategoryOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "root_only", "in": "query", "schema": { "type": "boolean" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "e2316fe3-01a9-432e-988f-67aaecc884ec" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoodsCategoryPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager", "cashier", "courier" ] } ] } }, "/orgs/{org_guid}/goods-categories/{category_guid}": { "get": { "tags": [ "GoodsCategories" ], "operationId": "GetGoodsCategoryById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "category_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "3be07968-5bd5-444e-90ed-b75324475151" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoodsCategory" }, "example": {"name":"моя категория товаров","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"6cc8334a-5b17-4979-bf96-a3745def72f4","type_of":"GoodsCategory"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager", "cashier", "courier" ] } ] }, "patch": { "tags": [ "GoodsCategories" ], "operationId": "UpdateGoodsCategory", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "category_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "1f9f1f8e-5f9e-489b-ab3e-895299e4535d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "delete": { "tags": [ "GoodsCategories" ], "operationId": "DeleteGoodsCategory", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "category_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "18c294a7-a20c-419e-818b-92e75f7d40b2" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/goods-categories/{category_guid}:unarchive": { "post": { "tags": [ "GoodsCategories" ], "operationId": "RestoreGoodsCategory", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "category_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cascade", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "608bce24-9c6f-43bb-8c6d-c4640c7f438d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/goods-categories/{category_guid}/subcategories": { "get": { "tags": [ "GoodsCategories" ], "operationId": "ListGoodsCategorySubCategories", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "category_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: name, description, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/GoodsCategoryOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "92417fa2-24d0-4184-83c1-0dfa63108a55" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoodsCategoryPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager", "cashier", "courier" ] } ] } }, "/orgs/{org_guid}/goods": { "post": { "tags": [ "Goods" ], "operationId": "CreateGood", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "e979769d-ec09-42d6-af77-8cde0cb6caab" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Good" }, "example": {"settlement_subject":"Product","name":"Наименование товара","uom":{"guid":"824a601b-cf4d-4843-ace7-122ade219ea2","type_of":"Uom"},"default_price":{"value":123,"currency":"RUB","type_of":"Money"},"tax":"Tax20","description":"Описание товара","made_in":"RUS","barcodes":"46009333,10012345678902","barcodes_local":"local-barcode-1,local-barcode-2","category":{"guid":"06dbf2e6-da33-43f3-aedd-02b142531e20","type_of":"GoodsCategory"},"is_serial":true,"is_markable":true,"is_part_of_package_of":7,"organization":{"guid":"0b066202-cec5-423f-aca6-01ae7a139669","type_of":"Organization"},"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","meta":"Metadata string","meta_data":{"meta-key-1":"meta-value-1","meta-key-2":"meta-value-2"},"guid":"18198b34-d1d6-4b6d-b8ad-471456896ea4","type_of":"Good"} }, "application/json": { "schema": { "$ref": "#/components/schemas/Good" }, "example": {"settlement_subject":"Product","name":"Наименование товара","uom":{"guid":"824a601b-cf4d-4843-ace7-122ade219ea2","type_of":"Uom"},"default_price":{"value":123,"currency":"RUB","type_of":"Money"},"tax":"Tax20","description":"Описание товара","made_in":"RUS","barcodes":"46009333,10012345678902","barcodes_local":"local-barcode-1,local-barcode-2","category":{"guid":"06dbf2e6-da33-43f3-aedd-02b142531e20","type_of":"GoodsCategory"},"is_serial":true,"is_markable":true,"is_part_of_package_of":7,"organization":{"guid":"0b066202-cec5-423f-aca6-01ae7a139669","type_of":"Organization"},"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","meta":"Metadata string","meta_data":{"meta-key-1":"meta-value-1","meta-key-2":"meta-value-2"},"guid":"18198b34-d1d6-4b6d-b8ad-471456896ea4","type_of":"Good"} }, "text/json": { "schema": { "$ref": "#/components/schemas/Good" }, "example": {"settlement_subject":"Product","name":"Наименование товара","uom":{"guid":"824a601b-cf4d-4843-ace7-122ade219ea2","type_of":"Uom"},"default_price":{"value":123,"currency":"RUB","type_of":"Money"},"tax":"Tax20","description":"Описание товара","made_in":"RUS","barcodes":"46009333,10012345678902","barcodes_local":"local-barcode-1,local-barcode-2","category":{"guid":"06dbf2e6-da33-43f3-aedd-02b142531e20","type_of":"GoodsCategory"},"is_serial":true,"is_markable":true,"is_part_of_package_of":7,"organization":{"guid":"0b066202-cec5-423f-aca6-01ae7a139669","type_of":"Organization"},"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","meta":"Metadata string","meta_data":{"meta-key-1":"meta-value-1","meta-key-2":"meta-value-2"},"guid":"18198b34-d1d6-4b6d-b8ad-471456896ea4","type_of":"Good"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Good" }, "example": {"settlement_subject":"Product","name":"Наименование товара","uom":{"guid":"824a601b-cf4d-4843-ace7-122ade219ea2","type_of":"Uom"},"default_price":{"value":123,"currency":"RUB","type_of":"Money"},"tax":"Tax20","description":"Описание товара","made_in":"RUS","barcodes":"46009333,10012345678902","barcodes_local":"local-barcode-1,local-barcode-2","category":{"guid":"06dbf2e6-da33-43f3-aedd-02b142531e20","type_of":"GoodsCategory"},"is_serial":true,"is_markable":true,"is_part_of_package_of":7,"organization":{"guid":"0b066202-cec5-423f-aca6-01ae7a139669","type_of":"Organization"},"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","meta":"Metadata string","meta_data":{"meta-key-1":"meta-value-1","meta-key-2":"meta-value-2"},"guid":"18198b34-d1d6-4b6d-b8ad-471456896ea4","type_of":"Good"} } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Good" }, "example": {"settlement_subject":"Product","name":"Наименование товара","uom":{"guid":"56dde006-387e-47ea-b135-15e1dbbbd9af","type_of":"Uom"},"default_price":{"value":123,"currency":"RUB","type_of":"Money"},"tax":"Tax20","description":"Описание товара","made_in":"RUS","barcodes":"46009333,10012345678902","barcodes_local":"local-barcode-1,local-barcode-2","category":{"guid":"98dfe74a-cdbb-446d-afe8-3a63ed61720b","type_of":"GoodsCategory"},"is_serial":true,"is_markable":true,"is_part_of_package_of":7,"organization":{"guid":"ee80ad0c-ec26-4ce9-9fb0-8f747e302030","type_of":"Organization"},"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","meta":"Metadata string","meta_data":{"meta-key-1":"meta-value-1","meta-key-2":"meta-value-2"},"guid":"b4e4c667-712e-408c-987c-ca2d80952a5e","type_of":"Good"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "delete": { "tags": [ "Goods" ], "operationId": "DeleteAllGoods", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "c691b99b-70d4-4a14-b6aa-3e2b266a402a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "get": { "tags": [ "Goods" ], "operationId": "ListGood", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "category_guid", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: name, description, barcode_ean13, barcode_local, barcodes, localbarcodes, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/GoodOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "barcode_contains", "in": "query", "schema": { "type": "string", "description": "barcode_contains" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "556b92fa-9ca2-4406-8011-3c764715c9df" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoodPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager", "cashier", "courier" ] } ] } }, "/orgs/{org_guid}/goods.batch": { "post": { "tags": [ "Goods" ], "operationId": "CreateManyGoods", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "e870c352-79be-43a5-a6e5-668572a83c90" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Good" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Good" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Good" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Good" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Good" } } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/goods/{good_guid}": { "get": { "tags": [ "Goods" ], "operationId": "GetGoodById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "good_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "fb69b222-33e5-4dec-a1fc-ad9a274dbb40" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Good" }, "example": {"settlement_subject":"Product","name":"Наименование товара","uom":{"guid":"a35eed44-6c91-4f09-a5d4-02f34ad91760","type_of":"Uom"},"default_price":{"value":123,"currency":"RUB","type_of":"Money"},"tax":"Tax20","description":"Описание товара","made_in":"RUS","barcodes":"46009333,10012345678902","barcodes_local":"local-barcode-1,local-barcode-2","category":{"guid":"39e145d2-7009-40cb-8830-4e86b4f2c442","type_of":"GoodsCategory"},"is_serial":true,"is_markable":true,"is_part_of_package_of":7,"organization":{"guid":"d4dba01a-2958-4f75-8c44-19f18802b331","type_of":"Organization"},"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","meta":"Metadata string","meta_data":{"meta-key-1":"meta-value-1","meta-key-2":"meta-value-2"},"guid":"19c016d0-3f4e-4729-bd49-883992df6290","type_of":"Good"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager", "cashier", "courier" ] } ] }, "patch": { "tags": [ "Goods" ], "operationId": "UpdateGood", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "good_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "cc87f14b-e29a-48f3-8582-a72f4e1d32b5" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "delete": { "tags": [ "Goods" ], "operationId": "DeleteGoods", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "good_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "ecfb0ac7-1124-43e5-928b-8027091cffa3" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/goods/{good_guid}:unarchive": { "post": { "tags": [ "Goods" ], "operationId": "RestoreGoods", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "good_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "2e5504e2-df92-4109-a17e-af8d36cf2640" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/registration-reports": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "CreateFiscalDocumentRegistrationReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "da24b6c5-8574-40ed-a631-061a6cb6789f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentRegistrationReport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentRegistrationReport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentRegistrationReport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentRegistrationReport" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentRegistrationReport" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/registration-reports/{doc_guid}": { "get": { "tags": [ "FiscalDocuments" ], "operationId": "GetFiscalDocumentRegistrationReportById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "4b7a80d9-6856-4251-97d2-bbf996e9ff10" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentRegistrationReport" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "FiscalDocuments" ], "operationId": "UpdateFiscalDocumentRegistrationReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "50956842-ce8f-4288-827c-37f795257cb7" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "FiscalDocuments" ], "operationId": "DeleteFiscalDocumentRegistrationReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "1f847f18-2669-4987-a2f0-426eb0664f3c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/registration-reports/{doc_guid}:unarchive": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "RestoreFiscalDocumentRegistrationReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "037f9de9-3629-4597-b17d-9fa83e396090" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/re-registration-reports": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "CreateFiscalDocumentReRegistrationReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "8532b527-573d-470d-9970-cf1bf5c7c9fc" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReRegistrationReport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReRegistrationReport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReRegistrationReport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReRegistrationReport" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReRegistrationReport" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/re-registration-reports/{doc_guid}": { "get": { "tags": [ "FiscalDocuments" ], "operationId": "GetFiscalDocumentReRegistrationReportById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "0dd27a2f-2999-4500-a49f-9e1ecd81c7b6" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReRegistrationReport" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "FiscalDocuments" ], "operationId": "UpdateFiscalDocumentReRegistrationReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "4a0bb8b0-943c-490b-b349-c07763f415ab" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "FiscalDocuments" ], "operationId": "DeleteFiscalDocumentReRegistrationReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "376c2cb8-614e-45db-8205-221559650197" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/re-registration-reports/{doc_guid}:unarchive": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "RestoreFiscalDocumentReRegistrationReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "79ff5fd8-a0cb-48b5-8b9e-7fa6296e4765" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/shift-closing-reports": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "CreateFiscalDocumentShiftClosingReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "4085485c-2fac-44d5-a10e-a3f4f5808702" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentShiftClosingReport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentShiftClosingReport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentShiftClosingReport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentShiftClosingReport" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentShiftClosingReport" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/shift-closing-reports/{doc_guid}": { "get": { "tags": [ "FiscalDocuments" ], "operationId": "GetFiscalDocumentShiftClosingReportById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "b918fc67-a691-42e0-b988-82dae6612478" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentShiftClosingReport" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "FiscalDocuments" ], "operationId": "UpdateFiscalDocumentShiftClosingReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "9f361288-976f-41af-9a30-69102280b76a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "FiscalDocuments" ], "operationId": "DeleteFiscalDocumentShiftClosingReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "938ee2a8-3336-4e55-b43b-d1003dc37ff8" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/shift-closing-reports/{doc_guid}:unarchive": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "RestoreFiscalDocumentShiftClosingReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "4bcb34c8-ed39-47b0-a496-e64b84e10ae1" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/shift-opening-reports": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "CreateFiscalDocumentShiftOpeningReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "f7b704b4-6522-4ea5-98c9-4697558c6a2b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentShiftOpeningReport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentShiftOpeningReport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentShiftOpeningReport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentShiftOpeningReport" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentShiftOpeningReport" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/shift-opening-reports/{doc_guid}": { "get": { "tags": [ "FiscalDocuments" ], "operationId": "GetFiscalDocumentShiftOpeningReportById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "00d15433-4452-4464-82d8-12bb9c58a248" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentShiftOpeningReport" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "FiscalDocuments" ], "operationId": "UpdateFiscalDocumentShiftOpeningReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "b977c354-63b0-4a34-8264-6da01575ba61" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "FiscalDocuments" ], "operationId": "DeleteFiscalDocumentShiftOpeningReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "fd03ec54-fc84-4a08-96d0-e973813ce89f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/shift-opening-reports/{doc_guid}:unarchive": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "RestoreFiscalDocumentShiftOpeningReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "b83680fd-c874-4e31-95c3-d90e6675b54b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/receipts": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "CreateFiscalDocumentReceipt", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "9381ed87-5ed0-43de-849b-0a48a932268e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReceipt" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReceipt" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReceipt" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/receipts/{doc_guid}": { "get": { "tags": [ "FiscalDocuments" ], "operationId": "GetFiscalDocumentReceiptById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "73755073-e519-4033-8315-50dcc6b40e3b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReceipt" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "FiscalDocuments" ], "operationId": "UpdateFiscalDocumentReceipt", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "e9850f80-5c71-425a-9146-05167a23a66f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "FiscalDocuments" ], "operationId": "DeleteFiscalDocumentReceipt", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "fce3d330-7c03-43b2-9cdb-ae0fc0af5e0c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/*/docs/receipts": { "get": { "tags": [ "FiscalDocuments" ], "operationId": "ListFiscalDocumentReceipt", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "guid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "402562ff-7cbd-4a71-a26c-7f0655b7d003" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFiscalDocumentPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/receipts/{doc_guid}:unarchive": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "RestoreFiscalDocumentReceipt", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "8b62f0b6-ba02-4d46-8e05-487c044e394b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/receipts-of-correction": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "CreateFiscalDocumentReceiptOfCorrection", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "ab7a45a1-73a9-4aa9-9cb6-317c44dd1cd7" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReceiptOfCorrection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReceiptOfCorrection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReceiptOfCorrection" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReceiptOfCorrection" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReceiptOfCorrection" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/receipts-of-correction/{doc_guid}": { "get": { "tags": [ "FiscalDocuments" ], "operationId": "GetFiscalDocumentReceiptOfCorrectionById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "7dcb66d1-6026-491f-acc5-ab5cc6d1328a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentReceiptOfCorrection" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "FiscalDocuments" ], "operationId": "UpdateFiscalDocumentReceiptOfCorrection", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "cab54330-1f2d-4e49-9654-c5c3b3fd0ec1" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "FiscalDocuments" ], "operationId": "DeleteFiscalDocumentReceiptOfCorrection", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "c5f8b1e8-ff30-4805-80d1-f5514d381cfb" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/receipts-of-correction/{doc_guid}:unarchive": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "RestoreFiscalDocumentReceiptOfCorrection", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "9c0b119f-27a5-4892-9b49-a0bef466a3d2" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/strict-forms": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "CreateFiscalDocumentStrictForm", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "21d7bf83-fc29-4adc-ab7e-c72615d81aaa" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentStrictForm" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentStrictForm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentStrictForm" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentStrictForm" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentStrictForm" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/strict-forms/{doc_guid}": { "get": { "tags": [ "FiscalDocuments" ], "operationId": "GetFiscalDocumentStrictFormById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "04113ebb-b430-4316-a602-4d2355163141" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentStrictForm" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "FiscalDocuments" ], "operationId": "UpdateFiscalDocumentStrictForm", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "66235af7-49c5-4a60-af09-0e6e768f983c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "FiscalDocuments" ], "operationId": "DeleteFiscalDocumentStrictForm", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "56bd9f43-2d20-47fc-a9dd-a4039a9d96f6" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/strict-forms/{doc_guid}:unarchive": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "RestoreFiscalDocumentStrictForm", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "d261cc6e-5fac-44bf-adea-25ae9170cf03" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/strict-forms-of-correction": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "CreateFiscalDocumentStrictFormOfCorrection", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "baa0d27a-fd37-4209-a6ad-6c3e5b0873bb" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentStrictFormOfCorrection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentStrictFormOfCorrection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentStrictFormOfCorrection" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentStrictFormOfCorrection" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentStrictFormOfCorrection" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/strict-forms-of-correction/{doc_guid}": { "get": { "tags": [ "FiscalDocuments" ], "operationId": "GetFiscalDocumentStrictFormOfCorrectionById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "1fa764af-19a6-4e87-b1bf-7d8773e6c4dc" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentStrictFormOfCorrection" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "FiscalDocuments" ], "operationId": "UpdateFiscalDocumentStrictFormOfCorrection", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "5efba613-2d95-4c65-9d77-b669fbbc5c3c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "FiscalDocuments" ], "operationId": "DeleteFiscalDocumentStrictFormOfCorrection", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "5ea86768-45ba-481f-81d0-488dd4f9e5ae" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/strict-forms-of-correction/{doc_guid}:unarchive": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "RestoreFiscalDocumentStrictFormOfCorrection", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "bc963647-6b59-4800-ac68-465b0faee2fd" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/fdr-closing-reports": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "CreateFiscalDocumentFiscalDriveClosingReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "8870acb0-e826-4766-9233-7b922c1dc2eb" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentFiscalDriveClosingReport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentFiscalDriveClosingReport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentFiscalDriveClosingReport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentFiscalDriveClosingReport" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentFiscalDriveClosingReport" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/fdr-closing-reports/{doc_guid}": { "get": { "tags": [ "FiscalDocuments" ], "operationId": "GetFiscalDocumentFiscalDriveClosingReportById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "e4bd2d76-1dba-4878-b01a-b805e3bfc8d2" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentFiscalDriveClosingReport" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "FiscalDocuments" ], "operationId": "UpdateFiscalDocumentFiscalDriveClosingReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "737b80c4-fcb9-4e15-9353-340c25c20abf" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "FiscalDocuments" ], "operationId": "DeleteFiscalDocumentFiscalDriveClosingReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "babd46cc-5751-4b6f-9058-bcbc8e7114ae" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/fdr-closing-reports/{doc_guid}:unarchive": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "RestoreFiscalDocumentFiscalDriveClosingReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "7ba087a5-91b2-41a0-b7bd-e887503492b7" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/operator-confirmations": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "CreateFiscalDocumentOperatorConfirmation", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "e76354ce-6f2f-466e-aa1d-1ccee8a4695b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentOperatorConfirmation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentOperatorConfirmation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentOperatorConfirmation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentOperatorConfirmation" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentOperatorConfirmation" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/operator-confirmations/{doc_guid}": { "get": { "tags": [ "FiscalDocuments" ], "operationId": "GetFiscalDocumentOperatorConfirmationById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "7a3077d3-3b93-4e2d-9e2a-0b3c4cb4c6b5" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentOperatorConfirmation" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "FiscalDocuments" ], "operationId": "UpdateFiscalDocumentOperatorConfirmation", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "9049e112-cd5c-4a2f-a189-29baac47b5c6" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "FiscalDocuments" ], "operationId": "DeleteFiscalDocumentOperatorConfirmation", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "7fb74f04-b5ac-474e-8986-b7b2a3f5c8e5" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/operator-confirmations/{doc_guid}:unarchive": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "RestoreFiscalDocumentOperatorConfirmation", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "9fd3d3c5-a4ac-4867-82af-b42d6ec53b96" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/settlement-reports": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "CreateFiscalDocumentSettlementReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "e9175ae7-cdea-40b9-b661-3363b6fe0e68" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentSettlementReport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentSettlementReport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentSettlementReport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentSettlementReport" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentSettlementReport" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/settlement-reports/{doc_guid}": { "get": { "tags": [ "FiscalDocuments" ], "operationId": "GetFiscalDocumentSettlementReportById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "969c90e9-b2ee-4628-83c4-93f5ad4d49b3" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDocumentSettlementReport" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "FiscalDocuments" ], "operationId": "UpdateFiscalDocumentSettlementReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "9a49e244-7e6f-4e8c-97e3-2ab8a453c42e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "FiscalDocuments" ], "operationId": "DeleteFiscalDocumentSettlementReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "50301e98-98d0-453b-b0ef-ff816860863b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/settlement-reports/{doc_guid}:unarchive": { "post": { "tags": [ "FiscalDocuments" ], "operationId": "RestoreFiscalDocumentSettlementReport", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "2d9b5353-dd60-43dc-bfc0-460f9522fc9c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs": { "get": { "tags": [ "FiscalDocuments" ], "operationId": "ListIFiscalDocument", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: number, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/FiscalDocOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "fiscal_form", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "description": "fiscal_form" } }, { "name": "number", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "number" } }, { "name": "issued_at_from", "in": "query", "schema": { "type": "string", "description": "issued_at_from", "format": "date-time" } }, { "name": "issued_at_to", "in": "query", "schema": { "type": "string", "description": "issued_at_to", "format": "date-time" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "be798214-9e6b-494d-b84a-c49075220d2b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFiscalDocumentPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/storage/{doc_guid}": { "get": { "tags": [ "FiscalDocuments" ], "operationId": "GetFiscalDocumentStorage", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "8fe4e9ad-89b6-4d03-a799-ada386fffb75" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFiscalDocument" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/storage": { "get": { "tags": [ "FiscalDocuments" ], "operationId": "ListFiscalDocumentStorage", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: number, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/FiscalDocOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "fiscal_form", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "description": "fiscal_form" } }, { "name": "number", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "number" } }, { "name": "issued_at_from", "in": "query", "schema": { "type": "string", "description": "issued_at_from", "format": "date-time" } }, { "name": "issued_at_to", "in": "query", "schema": { "type": "string", "description": "issued_at_to", "format": "date-time" } }, { "name": "fiscal_status", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FiscalStatus" }, "description": "fiscal_status" } }, { "name": "source_type", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/SourceType" }, "description": "source_type" } }, { "name": "outlet_guid", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "legal_entity_guid", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "legal_entity_guid" } }, { "name": "employee_guid", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "employee_guid" } }, { "name": "position_names", "in": "query", "schema": { "type": "string", "description": "position_names" } }, { "name": "registrar_serial_number", "in": "query", "schema": { "type": "string", "description": "registrar_serial_number" } }, { "name": "shift_number", "in": "query", "schema": { "type": "integer", "description": "shift_number", "format": "int32" } }, { "name": "payment_types", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FiscalPaymentTypes" }, "description": "payment_types" } }, { "name": "format", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "format" } }, { "name": "total_sum_from", "in": "query", "schema": { "type": "integer", "description": "total_sum_from", "format": "int64" } }, { "name": "total_sum_to", "in": "query", "schema": { "type": "integer", "description": "total_sum_to", "format": "int64" } }, { "name": "fiscal_document_guid", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "fiscal_document_guid" } }, { "name": "sale_session_type", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "sale_session_type" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "69620e57-5aba-4e2d-b6b4-73d90a004740" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFiscalDocumentPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}/docs/*/{doc_guid}": { "get": { "tags": [ "FiscalDocuments" ], "operationId": "GetIFiscalDocumentById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "doc_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "4fb101ea-fcf6-4aa3-bb67-3c129c7847f2" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFiscalDocument" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars": { "post": { "tags": [ "FiscalRegistrars" ], "operationId": "CreateFiscalRegistrar", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "06575785-241c-4d5c-8d56-e1958133487d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FiscalRegistrar" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FiscalRegistrar" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FiscalRegistrar" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FiscalRegistrar" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalRegistrar" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "get": { "tags": [ "FiscalRegistrars" ], "operationId": "ListFiscalRegistrar", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: name, model, registration_number, serial_number, fiscal_drive_number, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/FiscalRegistrarOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "guid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "37e6e0c6-c408-425b-8f2b-320635ecfe2c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalRegistrarPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}": { "get": { "tags": [ "FiscalRegistrars" ], "operationId": "GetFiscalRegistrarById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "a2a0af96-dacd-4e56-915c-46914abb6ac2" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalRegistrar" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "FiscalRegistrars" ], "operationId": "UpdateFiscalRegistrar", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "f9f731a2-b42a-4e26-bd7d-6d095d33b6ea" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "FiscalRegistrars" ], "operationId": "DeleteFiscalRegistrar", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "19dbd298-a7ed-4851-9d88-5f45119a00f8" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/fiscal-registrars/{registrar_guid}:unarchive": { "post": { "tags": [ "FiscalRegistrars" ], "operationId": "RestoreFiscalRegistrar", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "registrar_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "069f1a25-5f38-42e9-9c97-2c0498b0547d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/deals/sales": { "post": { "tags": [ "Sales" ], "operationId": "CreateSale", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "fcdd03a9-257a-4af4-b5fa-464de94b6385" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Sale" }, "example": {"outlet":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"Outlet"},"opened_by":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"Employee"},"opened_at":"2026-06-11T13:11:29.0600889Z","state":"New","payment_status":"NotPaid","shipping_status":"NotShipped","total_sum":{"value":10000,"currency":"RUB","type_of":"Money"},"positions":[{"settlement_subject":0,"name":"Конфеты","tax":"Tax20","sale_price":{"value":1000,"currency":"RUB","type_of":"Money"},"quantity":5.0,"total_sum":{"value":5000,"currency":"RUB","type_of":"Money"},"is_markable":false,"is_egais_markable":false,"guid":"00000000-0000-0000-0000-000000000000","type_of":"DealPosition"}],"source_type":"Pos","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"8980cadf-1b92-47a5-a901-a38b43a3aa85","type_of":"Sale"} }, "application/json": { "schema": { "$ref": "#/components/schemas/Sale" }, "example": {"outlet":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"Outlet"},"opened_by":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"Employee"},"opened_at":"2026-06-11T13:11:29.0600889Z","state":"New","payment_status":"NotPaid","shipping_status":"NotShipped","total_sum":{"value":10000,"currency":"RUB","type_of":"Money"},"positions":[{"settlement_subject":0,"name":"Конфеты","tax":"Tax20","sale_price":{"value":1000,"currency":"RUB","type_of":"Money"},"quantity":5.0,"total_sum":{"value":5000,"currency":"RUB","type_of":"Money"},"is_markable":false,"is_egais_markable":false,"guid":"00000000-0000-0000-0000-000000000000","type_of":"DealPosition"}],"source_type":"Pos","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"8980cadf-1b92-47a5-a901-a38b43a3aa85","type_of":"Sale"} }, "text/json": { "schema": { "$ref": "#/components/schemas/Sale" }, "example": {"outlet":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"Outlet"},"opened_by":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"Employee"},"opened_at":"2026-06-11T13:11:29.0600889Z","state":"New","payment_status":"NotPaid","shipping_status":"NotShipped","total_sum":{"value":10000,"currency":"RUB","type_of":"Money"},"positions":[{"settlement_subject":0,"name":"Конфеты","tax":"Tax20","sale_price":{"value":1000,"currency":"RUB","type_of":"Money"},"quantity":5.0,"total_sum":{"value":5000,"currency":"RUB","type_of":"Money"},"is_markable":false,"is_egais_markable":false,"guid":"00000000-0000-0000-0000-000000000000","type_of":"DealPosition"}],"source_type":"Pos","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"8980cadf-1b92-47a5-a901-a38b43a3aa85","type_of":"Sale"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Sale" }, "example": {"outlet":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"Outlet"},"opened_by":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"Employee"},"opened_at":"2026-06-11T13:11:29.0600889Z","state":"New","payment_status":"NotPaid","shipping_status":"NotShipped","total_sum":{"value":10000,"currency":"RUB","type_of":"Money"},"positions":[{"settlement_subject":0,"name":"Конфеты","tax":"Tax20","sale_price":{"value":1000,"currency":"RUB","type_of":"Money"},"quantity":5.0,"total_sum":{"value":5000,"currency":"RUB","type_of":"Money"},"is_markable":false,"is_egais_markable":false,"guid":"00000000-0000-0000-0000-000000000000","type_of":"DealPosition"}],"source_type":"Pos","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"8980cadf-1b92-47a5-a901-a38b43a3aa85","type_of":"Sale"} } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sale" }, "example": {"outlet":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"Outlet"},"opened_by":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"Employee"},"opened_at":"2026-06-11T13:11:29.0607359Z","state":"New","payment_status":"NotPaid","shipping_status":"NotShipped","total_sum":{"value":10000,"currency":"RUB","type_of":"Money"},"positions":[{"settlement_subject":0,"name":"Конфеты","tax":"Tax20","sale_price":{"value":1000,"currency":"RUB","type_of":"Money"},"quantity":5.0,"total_sum":{"value":5000,"currency":"RUB","type_of":"Money"},"is_markable":false,"is_egais_markable":false,"guid":"00000000-0000-0000-0000-000000000000","type_of":"DealPosition"}],"source_type":"Pos","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"42ddb1a5-964d-49de-aa1b-03c39831bdea","type_of":"Sale"} } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "get": { "tags": [ "Sales" ], "operationId": "ListSale", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/DealOrderings" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: number, comment, custom_properties, deal_permissions, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "opened_at_from", "in": "query", "schema": { "type": "string", "description": "opened_at_from", "format": "date-time" } }, { "name": "opened_at_to", "in": "query", "schema": { "type": "string", "description": "opened_at_to", "format": "date-time" } }, { "name": "total_sum_from", "in": "query", "schema": { "type": "integer", "description": "total_sum_from", "format": "int64" } }, { "name": "total_sum_to", "in": "query", "schema": { "type": "integer", "description": "total_sum_to", "format": "int64" } }, { "name": "states", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealStates" }, "description": "states" } }, { "name": "payment_statuses", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealPaymentStatus" }, "description": "payment_statuses" } }, { "name": "shipping_statuses", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealShippingStatus" }, "description": "shipping_statuses" } }, { "name": "outlet_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "opened_by_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "opened_by_guid" } }, { "name": "workplace_guid", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "workplace_guid" } }, { "name": "comment_contains", "in": "query", "schema": { "type": "string", "description": "comment_contains" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "db8d5175-8238-4513-88dc-093cae945ea4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalePage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/deals/sales.batch": { "post": { "tags": [ "Sales" ], "operationId": "CreateManySale", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "0b0f523f-e6fa-4531-a056-a665c4f12fa7" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sale" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sale" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sale" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sale" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sale" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/deals/sales/{deal_guid}": { "get": { "tags": [ "Sales" ], "operationId": "GetSaleById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "b214dbbf-5cd4-4ef6-b5b5-5718690d78ae" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sale" }, "example": {"outlet":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"Outlet"},"opened_by":{"guid":"00000000-0000-0000-0000-000000000000","type_of":"Employee"},"opened_at":"2026-06-11T13:11:29.0649763Z","state":"New","payment_status":"NotPaid","shipping_status":"NotShipped","total_sum":{"value":10000,"currency":"RUB","type_of":"Money"},"positions":[{"settlement_subject":0,"name":"Конфеты","tax":"Tax20","sale_price":{"value":1000,"currency":"RUB","type_of":"Money"},"quantity":5.0,"total_sum":{"value":5000,"currency":"RUB","type_of":"Money"},"is_markable":false,"is_egais_markable":false,"guid":"00000000-0000-0000-0000-000000000000","type_of":"DealPosition"}],"source_type":"Pos","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"040dbbe1-807b-4432-bbc6-07775339a0b8","type_of":"Sale"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "delete": { "tags": [ "Sales" ], "operationId": "DeleteSale", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "9c23bcc1-5f0a-4958-8bd0-c9bad48518a7" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "Sales" ], "operationId": "UpdateSale", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "9fb126c5-8477-46e6-84fa-1f440ad3c402" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/deals/sales/{deal_guid}:unarchive": { "post": { "tags": [ "Sales" ], "operationId": "RestoreSale", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "f537471b-1575-44d4-8f3c-4a13f896c83c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/async": { "get": { "tags": [ "AsyncTasks" ], "operationId": "ListIAsyncTask", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/AsyncTaskOrdering" } }, { "name": "task_status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncTaskStatuses" }, "description": "task_status" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "252784f1-95c9-4a24-89b2-d677a2ec9502" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IAsyncTaskPage" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports": { "get": { "tags": [ "Export" ], "operationId": "ListExportTask", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/AsyncTaskOrdering" } }, { "name": "task_status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncTaskStatuses" }, "description": "task_status" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "f5f1d1ef-354a-4850-b0e7-5ae6d78ead30" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IAsyncTaskPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/imports": { "get": { "tags": [ "Import" ], "operationId": "ListImportTask", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/AsyncTaskOrdering" } }, { "name": "task_status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncTaskStatuses" }, "description": "task_status" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "24f867c6-9e28-4345-8cc2-c003c4a8de01" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IAsyncTaskPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/nomenclature": { "get": { "tags": [ "NomenclatureExport" ], "operationId": "ListNomenclatureExportTask", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/AsyncTaskOrdering" } }, { "name": "task_status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncTaskStatuses" }, "description": "task_status" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "74afe3a2-9493-40df-945e-e15b4d054987" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NomenclatureExportTaskPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/nomenclature:new.xlsx": { "post": { "tags": [ "NomenclatureExport" ], "operationId": "CreateNomenclatureExportTask", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "2fb855c7-2be0-49db-9e9f-2a88870212d1" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NomenclatureExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NomenclatureExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NomenclatureExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NomenclatureExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NomenclatureExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/nomenclature/{task_guid}": { "get": { "tags": [ "NomenclatureExport" ], "operationId": "GetAsyncTaskById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "4233a0bd-5a49-4371-b4fb-4ddd97e6955f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/nomenclature/{task_guid}/result.xlsx": { "get": { "tags": [ "NomenclatureExport" ], "operationId": "GetNomenclatureExportTaskFile", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "6131040b-8adf-4c35-8d53-5e3911578e3d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/nomenclature/{task_guid}:cancel": { "post": { "tags": [ "NomenclatureExport" ], "operationId": "CancelNomenclatureExportTask", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "80494ddf-7ead-41fd-a6ea-1a7835e52044" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/imports/nomenclature": { "get": { "tags": [ "NomenclatureImport" ], "operationId": "ListNomenclatureImportTask", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/AsyncTaskOrdering" } }, { "name": "task_status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncTaskStatuses" }, "description": "task_status" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "15d42b19-1229-4af6-908f-5d505760ab51" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NomenclatureImportTaskPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/imports/nomenclature/template.xlsx": { "get": { "tags": [ "NomenclatureImport" ], "operationId": "GetNomenclatureImportTaskTemplateFile", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "9d0843b2-085e-48f1-ab33-7c88d9010901" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/imports/nomenclature:new.xlsx": { "post": { "tags": [ "NomenclatureImport" ], "operationId": "CreateNomenclatureImportTask", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "params", "in": "query", "schema": { "$ref": "#/components/schemas/NomenclatureImportFromExcelParams" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "d5e49442-5619-4de0-8a02-fa05605297d6" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NomenclatureImportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/imports/nomenclature/{task_guid}": { "get": { "tags": [ "NomenclatureImport" ], "operationId": "GetNomenclatureImportTaskById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "774531c9-25b9-4a86-bcfb-06b76649a89c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/imports/nomenclature/{task_guid}/source.xlsx": { "get": { "tags": [ "NomenclatureImport" ], "operationId": "GetNomenclatureImportTaskSourceFile", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "35782510-ddbf-4e05-8c2a-c83ace5d77e3" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/imports/nomenclature/{task_guid}:confirm": { "post": { "tags": [ "NomenclatureImport" ], "operationId": "ConfirmNomenclatureImportTask", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "2b8473ed-0c0a-40f3-9a89-9a40609dcf9a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/imports/nomenclature/{task_guid}:cancel": { "post": { "tags": [ "NomenclatureImport" ], "operationId": "CancelNomenclatureImportTask", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "162b8e42-e96d-4cdb-8f2b-99b130a83ac1" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/imports/nomenclature/*:cancel": { "post": { "tags": [ "NomenclatureImport" ], "operationId": "CancelAllAsyncTask", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "7ae0800a-11bb-4d33-84f5-fdc7bec8c517" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/imports/nomenclature/{task_guid}/previews/uoms": { "get": { "tags": [ "NomenclatureImportTaskPreview" ], "operationId": "GetImportPreviewItemUom", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "1a2d358f-c0e4-4f73-b725-790ded850b05" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UomImportPreviewItemPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/imports/nomenclature/{task_guid}/previews/categories": { "get": { "tags": [ "NomenclatureImportTaskPreview" ], "operationId": "GetImportPreviewItemGoodsCategory", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "0b45688b-dbe3-456a-9745-f4de64be7ac1" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoodsCategoryImportPreviewItemPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/imports/nomenclature/{task_guid}/previews/goods": { "get": { "tags": [ "NomenclatureImportTaskPreview" ], "operationId": "GetImportPreviewItemGoods", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "48a42b9c-0ad2-4d65-afd9-93e021d96576" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoodImportPreviewItemPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/operationsreports": { "get": { "tags": [ "OperationsReportExport" ], "operationId": "ListOperationReportExportTask", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/AsyncTaskOrdering" } }, { "name": "task_status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncTaskStatuses" }, "description": "task_status" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "e1b6fe9d-eb49-4fef-b6ca-ab9d98a2e45b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTaskPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/reporttransactions:new.xlsx": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskTransactExcel", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "2dad1de9-3fe8-43f2-8ef1-42b94947c114" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportTransactionExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportTransactionExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportTransactionExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportTransactionExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/reporttransactions:new.csv": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskTransactCSV", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "6fc20172-003c-4a96-a828-a11b71d14580" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportTransactionExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportTransactionExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportTransactionExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportTransactionExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/reportfiscals:new.xlsx": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskFiscalExcel", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "80f90ec4-c231-474e-a306-0137c5138762" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportFiscalExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportFiscalExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportFiscalExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportFiscalExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/reportfiscals:new.csv": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskFiscalCSV", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "85c5b7ab-ab7b-4c8a-88c9-68883b05783e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportFiscalExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportFiscalExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportFiscalExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportFiscalExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/reportmoneys:new.xlsx": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskMoneyExcel", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "29bc9d4c-70ba-4684-9c37-f75ca1ceb140" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportMoneyExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportMoneyExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportMoneyExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportMoneyExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/reportmoneys:new.csv": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskMoneyCSV", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "f0eefb0d-38dd-4143-8898-fb69fe0538d0" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportMoneyExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportMoneyExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportMoneyExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportMoneyExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/reportpaymentsrefunds:new.xlsx": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskPaymentExcel", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "b7e407f7-3c72-4deb-a100-ef87e252c2bd" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportPaymentAndRefundExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportPaymentAndRefundExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportPaymentAndRefundExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportPaymentAndRefundExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/reportpaymentsrefunds:new.csv": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskPaymentCSV", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "e19c0ee7-c73c-4060-8d47-9f7ccf829c3f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportPaymentAndRefundExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportPaymentAndRefundExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportPaymentAndRefundExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportPaymentAndRefundExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/reportcombined:new.xlsx": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskСombinedExcel", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "d3cb2c05-fccd-499c-a32c-b2770a438dbb" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportCombinedExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportCombinedExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportCombinedExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportCombinedExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/reportcombined:new.csv": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskСombinedCSV", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "8868c7bb-c377-4e1c-b7d2-c8505a4d6051" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportCombinedExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportCombinedExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportCombinedExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportCombinedExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/nomenclature/results:new.xlsx": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskNomenclatureResultExcel", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "0d2c873c-28bb-4ba5-b84c-8110874c4381" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureResultExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureResultExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureResultExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureResultExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/nomenclature/results:new.csv": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskNomenclatureResultCSV", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "8d174e8a-ff82-4731-b3e7-cf72fa3c717d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureResultExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureResultExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureResultExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureResultExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/nomenclature/balances/results:new.xlsx": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskNomenclatureBalancesResultExcel", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "b8472eb6-4934-443b-8f28-aa3da4464b10" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureBalancesResultExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureBalancesResultExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureBalancesResultExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureBalancesResultExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/nomenclature/balances/results:new.csv": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskNomenclatureBalancesResultCSV", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "e446738f-38c8-46d4-bc69-508b76b38970" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureBalancesResultExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureBalancesResultExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureBalancesResultExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureBalancesResultExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/nomenclature/profit/results:new.xlsx": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskNomenclatureProfitResultExcel", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "3e5be896-b318-4e8f-80d9-23db6517a9ce" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureProfitResultExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureProfitResultExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureProfitResultExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureProfitResultExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/nomenclature/profit/results:new.csv": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskNomenclatureProfitResultCSV", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "c91e1735-752d-42e8-8437-119ea7941341" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureProfitResultExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureProfitResultExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureProfitResultExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureProfitResultExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/nomenclature/minimum-balances/results:new.xlsx": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskNomenclatureStocksLimitsResultExcel", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "d4f62785-ceb0-42fc-b635-bd28a730ff4e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureStocksLimitsResultExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureStocksLimitsResultExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureStocksLimitsResultExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureStocksLimitsResultExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/nomenclature/minimum-balances/results:new.csv": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CreateOperationReportExportTaskNomenclatureStocksLimitsResultCSV", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "6bea6c19-19f3-4f3a-951a-d71a053b3dd2" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureStocksLimitsResultExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureStocksLimitsResultExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureStocksLimitsResultExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportNomenclatureStocksLimitsResultExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationReportExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/operationsreports/{task_guid}": { "get": { "tags": [ "OperationsReportExport" ], "operationId": "GetOperationReportExportTaskById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "bc8c4c52-283c-4409-a921-49ebae7a728c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/operationsreports/{task_guid}/result.xlsx": { "get": { "tags": [ "OperationsReportExport" ], "operationId": "GetOperationReportExportTaskFileXLSX", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "25b41b47-479d-4d6f-82e2-f81f057aefe5" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/operationsreports/{task_guid}/result.csv": { "get": { "tags": [ "OperationsReportExport" ], "operationId": "GetOperationReportExportTaskFileCSV", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "da57bde5-cee4-4126-9737-cbbd94de9d73" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/operationsreports/{task_guid}:cancel": { "post": { "tags": [ "OperationsReportExport" ], "operationId": "CancelOperationReportExportTask", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "db099237-3ea1-4472-a69b-9944d10e4a26" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/revenuereports": { "get": { "tags": [ "RevenueReportsExport" ], "operationId": "ListRevenueReportsExportTask", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/AsyncTaskOrdering" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "task_status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncTaskStatuses" }, "description": "task_status" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "5f257e0d-88ab-42ab-82a7-88f1a2c22c6a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportTaskPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/revenueperiods:new.xlsx": { "post": { "tags": [ "RevenueReportsExport" ], "operationId": "CreateRevenueReportsExportTaskExcel", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "48e065de-3cd8-45b5-82e7-c06fe21f1118" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/revenueperiods:new.csv": { "post": { "tags": [ "RevenueReportsExport" ], "operationId": "CreateRevenueReportsExportTaskCSV", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "9f8b29a3-2bfc-4faa-89ce-ca1699f4246f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/revenueoutletsperiods:new.xlsx": { "post": { "tags": [ "RevenueReportsExport" ], "operationId": "CreateRevenueReportsExportTaskOutletExcel", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "4d730dc4-7c2f-4da5-b2b9-f1788a9f19f2" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/revenueoutletsperiods:new.csv": { "post": { "tags": [ "RevenueReportsExport" ], "operationId": "CreateRevenueReportsExportTaskOutletCSV", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "8d228d21-bb6e-4f42-9fb7-e84d688556ac" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/revenueemployeesperiods:new.xlsx": { "post": { "tags": [ "RevenueReportsExport" ], "operationId": "CreateRevenueReportsExportTaskEmployeeExcel", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "2f210863-9d35-45f9-9a2d-1b64fc2912a5" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/revenueemployeesperiods:new.csv": { "post": { "tags": [ "RevenueReportsExport" ], "operationId": "CreateRevenueReportsExportTaskEmployeeCSV", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "fb6fee63-35be-4e67-9b4b-d81ccbc65185" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportParams" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevenueReportsExportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/revenuereports/{task_guid}": { "get": { "tags": [ "RevenueReportsExport" ], "operationId": "GetRevenueReportsExportTaskById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "615f9c97-1840-432a-960d-e27c92b17b49" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/revenuereports/{task_guid}/result.xlsx": { "get": { "tags": [ "RevenueReportsExport" ], "operationId": "GetRevenueReportsExportTaskFileXLSX", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "c5c91412-3f5a-4ffb-b60b-9d0e22afe9bb" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/revenuereports/{task_guid}/result.csv": { "get": { "tags": [ "RevenueReportsExport" ], "operationId": "GetRevenueReportsExportTaskFileCSV", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "55d2a6a3-6ef8-4b7a-8a06-7dba0efae2e8" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/exports/revenuereports/{task_guid}:cancel": { "post": { "tags": [ "RevenueReportsExport" ], "operationId": "CancelRevenueReportsExportTask", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "task_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "3a62bbe5-2f80-49f2-aefc-85637eee18ae" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/terminals/bank": { "post": { "tags": [ "Terminals" ], "operationId": "CreateBankTerminal", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "d1ecad4a-84c3-462c-a18d-e9ac1a2421ae" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BankTerminal" }, "example": {"type_of":"BankTerminal","model":"MyTerminal123","terminal_id":"my_term_id123","online_type":"Offline","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"298f8c9c-6ba3-40ac-b58c-91ec7edec4a0"} }, "application/json": { "schema": { "$ref": "#/components/schemas/BankTerminal" }, "example": {"type_of":"BankTerminal","model":"MyTerminal123","terminal_id":"my_term_id123","online_type":"Offline","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"298f8c9c-6ba3-40ac-b58c-91ec7edec4a0"} }, "text/json": { "schema": { "$ref": "#/components/schemas/BankTerminal" }, "example": {"type_of":"BankTerminal","model":"MyTerminal123","terminal_id":"my_term_id123","online_type":"Offline","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"298f8c9c-6ba3-40ac-b58c-91ec7edec4a0"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BankTerminal" }, "example": {"type_of":"BankTerminal","model":"MyTerminal123","terminal_id":"my_term_id123","online_type":"Offline","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"298f8c9c-6ba3-40ac-b58c-91ec7edec4a0"} } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankTerminal" }, "example": {"type_of":"BankTerminal","model":"MyTerminal123","terminal_id":"my_term_id123","online_type":"Offline","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"6836a635-d8f9-4922-9fc5-68feda754a4f"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "get": { "tags": [ "Terminals" ], "operationId": "ListBankTerminal", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: model, merchant_id, term_id, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/TerminalOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "OnlineType", "in": "query", "schema": { "$ref": "#/components/schemas/PTOnlineType" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "439fcc34-9a5c-4241-a13f-325c69293618" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankTerminalPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/terminals/bank/{terminal_guid}": { "get": { "tags": [ "Terminals" ], "operationId": "GetBankTerminalById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "43306cd5-122a-4db5-9818-3ad3683e1222" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankTerminal" }, "example": {"type_of":"BankTerminal","model":"MyTerminal123","terminal_id":"my_term_id123","online_type":"Offline","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","guid":"62d60661-25de-4cd5-bd82-970b35e7c8fe"} } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "Terminals" ], "operationId": "UpdateBankTerminal", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "66243cb8-a7a4-43dc-9833-2fd7c048d64e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "Terminals" ], "operationId": "DeleteBankTerminal", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "db73f0f2-6a17-4c37-9abe-bb3666b5abce" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/terminals/bank/{terminal_guid}:unarchive": { "post": { "tags": [ "Terminals" ], "operationId": "RestoreBankTerminal", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "5ce727b5-4536-4cde-981a-754c203aaefc" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/terminals/quick-payments": { "post": { "tags": [ "Terminals" ], "operationId": "CreateQuickPaymentsTerminal", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "460e1fd4-cf68-4c58-86af-6ccfb69cf328" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/QuickPaymentsTerminal" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QuickPaymentsTerminal" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuickPaymentsTerminal" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/QuickPaymentsTerminal" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuickPaymentsTerminal" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "get": { "tags": [ "Terminals" ], "operationId": "ListQuickPaymentsTerminal", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: model, merchant_id, term_id, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/TerminalOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "OnlineType", "in": "query", "schema": { "$ref": "#/components/schemas/PTOnlineType" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "3b613cf9-0205-4e26-a662-b478e9d69518" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuickPaymentsTerminalPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/terminals/quick-payments/{terminal_guid}": { "get": { "tags": [ "Terminals" ], "operationId": "GetQuickPaymentsTerminalById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "6d44c042-c6b4-4525-b88a-cc7955d80d79" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuickPaymentsTerminal" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "Terminals" ], "operationId": "UpdateQuickPaymentsTerminal", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "a748008d-3ba9-4cd2-9ad5-7bab99af6092" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "Terminals" ], "operationId": "DeleteQuickPaymentsTerminal", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "13eaae69-0678-49ac-9942-c68413676719" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/terminals/quick-payments/{terminal_guid}:unarchive": { "post": { "tags": [ "Terminals" ], "operationId": "RestoreQuickPaymentsTerminal", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "4040561d-fe7e-4d14-9988-3141dd5d6f16" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/terminals": { "get": { "tags": [ "Terminals" ], "operationId": "ListITerminalBase", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: model, merchant_id, term_id, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/TerminalOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "96014f85-cd4c-4b43-a776-f4694e7b7c36" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ITerminalBasePage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/terminals/*/{terminal_guid}": { "get": { "tags": [ "Terminals" ], "operationId": "GetITerminalBaseById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "3f935ea5-60aa-4e6d-a2e2-e734f7d94f34" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ITerminalBase" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/terminals/bank/{terminal_guid}/transactions": { "post": { "tags": [ "Transactions" ], "operationId": "CreateBankTransaction", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "b69a8c8d-4057-4569-9f3a-c6160f315815" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BankTransaction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BankTransaction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BankTransaction" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BankTransaction" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankTransaction" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "get": { "tags": [ "Transactions" ], "operationId": "ListBankTransaction", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: merchant_id, term_id, authorized_amount, authorization_code, aid, rrn, card_holder, card_number, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/TransactionOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "operation", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TransactionOperationTypes" }, "description": "operation" } }, { "name": "registered_at_from", "in": "query", "schema": { "type": "string", "description": "registered_at_from", "format": "date-time" } }, { "name": "registered_at_to", "in": "query", "schema": { "type": "string", "description": "registered_at_to", "format": "date-time" } }, { "name": "amount_from", "in": "query", "schema": { "type": "integer", "description": "amount_from", "format": "int64" } }, { "name": "amount_to", "in": "query", "schema": { "type": "integer", "description": "amount_to", "format": "int64" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "c2ff4f17-1d73-432f-b17d-cbeb411e0dd6" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankTransactionPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/terminals/bank/{terminal_guid}/transactions/{transaction_guid}": { "get": { "tags": [ "Transactions" ], "operationId": "GetBankTransactionById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "transaction_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "77e2b10b-f644-4c64-b0c7-a966fa7fbf6f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankTransaction" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "Transactions" ], "operationId": "UpdateBankTransaction", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "transaction_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "16157706-11e0-4c4c-9bd9-744cd57c525c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "Transactions" ], "operationId": "DeleteBankTransaction", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "transaction_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "a623d6d6-26b1-4ce8-87fb-1b689adeb45f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/terminals/bank/{terminal_guid}/transactions/{transaction_guid}:unarchive": { "post": { "tags": [ "Transactions" ], "operationId": "RestoreBankTransaction", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "transaction_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "f4dbaf5e-41a2-482d-ae45-35910c2cc8f4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/terminals/quick-payments/{terminal_guid}/transactions": { "post": { "tags": [ "Transactions" ], "operationId": "CreateQuickPaymentsTransaction", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "478c462b-9486-4c1c-91d7-0e68582400ee" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/QuickPaymentsTransaction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QuickPaymentsTransaction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuickPaymentsTransaction" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/QuickPaymentsTransaction" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuickPaymentsTransaction" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "get": { "tags": [ "Transactions" ], "operationId": "ListQuickPaymentsTransaction", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: merchant_id, term_id, authorized_amount, authorization_code, aid, rrn, card_holder, card_number, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/TransactionOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "operation", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TransactionOperationTypes" }, "description": "operation" } }, { "name": "registered_at_from", "in": "query", "schema": { "type": "string", "description": "registered_at_from", "format": "date-time" } }, { "name": "registered_at_to", "in": "query", "schema": { "type": "string", "description": "registered_at_to", "format": "date-time" } }, { "name": "amount_from", "in": "query", "schema": { "type": "integer", "description": "amount_from", "format": "int64" } }, { "name": "amount_to", "in": "query", "schema": { "type": "integer", "description": "amount_to", "format": "int64" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "f6fb9ad1-e7e2-40a4-ae99-a9a513392b2a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuickPaymentsTransactionPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/terminals/quick-payments/{terminal_guid}/transactions/{transaction_guid}": { "get": { "tags": [ "Transactions" ], "operationId": "GetQuickPaymentsTransactionById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "transaction_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "e8668cd8-fc86-4983-a3af-35bd2cd219f6" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuickPaymentsTransaction" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] }, "patch": { "tags": [ "Transactions" ], "operationId": "UpdateQuickPaymentsTransaction", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "transaction_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "ff27708a-49e7-4dac-b691-aaa74a280b4f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] }, "delete": { "tags": [ "Transactions" ], "operationId": "DeleteQuickPaymentsTransaction", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "transaction_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "7a41fbc3-72c2-4ac2-987a-4fe96daaf9e6" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/terminals/quick-payments/{terminal_guid}/transactions/{transaction_guid}:unarchive": { "post": { "tags": [ "Transactions" ], "operationId": "RestoreQuickPaymentsTransaction", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "transaction_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "51eccf0a-45d6-45e6-9b89-2a0e2ed45c0a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/orgs/{org_guid}/terminals/*/{terminal_guid}/transactions": { "get": { "tags": [ "Transactions" ], "operationId": "ListITransactionBase", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "enum": [ "*" ], "type": "string", "description": "*" } ] } }, { "name": "created_from", "in": "query", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "query", "in": "query", "description": "Поиск производится по полям: merchant_id, term_id, authorized_amount, authorization_code, aid, rrn, card_holder, card_number, meta, metadata", "schema": { "maxLength": 64, "minLength": 1, "type": "string", "description": "query" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/TransactionOrderings" } }, { "name": "page_token", "in": "query", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "operation", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TransactionOperationTypes" }, "description": "operation" } }, { "name": "registered_at_from", "in": "query", "schema": { "type": "string", "description": "registered_at_from", "format": "date-time" } }, { "name": "registered_at_to", "in": "query", "schema": { "type": "string", "description": "registered_at_to", "format": "date-time" } }, { "name": "amount_from", "in": "query", "schema": { "type": "integer", "description": "amount_from", "format": "int64" } }, { "name": "amount_to", "in": "query", "schema": { "type": "integer", "description": "amount_to", "format": "int64" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "a5fb35f1-e057-485d-819a-b7159f9c924d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ITransactionBasePage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/terminals/*/*/transactions/{transaction_guid}": { "get": { "tags": [ "Transactions" ], "operationId": "GetITransactionBaseByIdOnly", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "transaction_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "6a4871e3-af26-433b-be29-ad86805c3b30" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ITransactionBase" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/terminals/*/{terminal_guid}/transactions/{transaction_guid}": { "get": { "tags": [ "Transactions" ], "operationId": "GetITransactionBaseById", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "terminal_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "transaction_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "be6cda92-9d30-4e4f-b5b1-f0a78ec639d0" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ITransactionBase" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } } }, "components": { "schemas": { "ActivateWorkplaceCredentials": { "required": [ "activation_code" ], "type": "object", "properties": { "activation_code": { "maxLength": 8, "minLength": 0, "pattern": "^\\d+$", "type": "string", "description": "activation_code" } }, "additionalProperties": false }, "AdditionalDealAttributes": { "type": "object", "properties": { "settlement_location": { "maxLength": 256, "type": "string", "description": "settlement_location", "nullable": true }, "printable_header": { "maxLength": 256, "minLength": 0, "type": "array", "items": { "type": "string" }, "description": "printable_header", "nullable": true }, "printable_footer": { "maxLength": 256, "minLength": 0, "type": "array", "items": { "type": "string" }, "description": "printable_footer", "nullable": true }, "printable_qr": { "maxLength": 4096, "type": "string", "description": "printable_qr", "format": "uri", "nullable": true } }, "additionalProperties": false }, "AdditionalDealPositionAttributes": { "type": "object", "properties": { "as_agent_type_of": { "$ref": "#/components/schemas/FEAgentTypes" }, "transfer_operator_name": { "maxLength": 64, "type": "string", "description": "transfer_operator_name", "nullable": true }, "transfer_operator_phones": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "transfer_operator_phones", "nullable": true }, "transfer_operator_address": { "maxLength": 256, "type": "string", "description": "transfer_operator_address", "nullable": true }, "transfer_operator_inn": { "type": "string", "description": "transfer_operator_inn", "nullable": true }, "paying_agent_operation": { "maxLength": 24, "type": "string", "description": "paying_agent_operation", "nullable": true }, "paying_agent_phones": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "paying_agent_phones", "nullable": true }, "payment_operator_phones": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "payment_operator_phones", "nullable": true }, "supplier_name": { "maxLength": 256, "type": "string", "description": "supplier_name", "nullable": true }, "supplier_inn": { "type": "string", "description": "supplier_inn", "nullable": true }, "supplier_phones": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "supplier_phones", "nullable": true }, "declaration_number": { "maxLength": 32, "type": "string", "description": "declaration_number", "nullable": true }, "excise_fee": { "type": "integer", "description": "excise_fee", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AsyncTask": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AsyncTaskStatuses" }, "progress": { "type": "integer", "description": "progress", "format": "int32" }, "resolutions": { "type": "array", "items": { "$ref": "#/components/schemas/Resolution" }, "description": "resolutions", "nullable": true }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "AsyncTaskOrdering": { "enum": [ "created_at_asc", "created_at_desc", "updated_at_asc", "updated_at_desc" ], "type": "string" }, "AsyncTaskStatuses": { "enum": [ "InQueue", "InProgress", "WaitingForFeedback", "Completed", "Canceled" ], "type": "string" }, "AuthOrganizationExtension": { "required": [ "signature", "version" ], "type": "object", "properties": { "signature": { "maxLength": 128, "minLength": 8, "type": "string", "description": "signature" }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "AuthResponseType": { "enum": [ "Session", "Token" ], "type": "string" }, "BNPLPaymentPart": { "required": [ "amount", "status" ], "type": "object", "properties": { "podeli_details": { "$ref": "#/components/schemas/PodeliDetails" }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "amount": { "$ref": "#/components/schemas/Money" }, "status": { "$ref": "#/components/schemas/PaymentPartStatuses" }, "primary_payment_part": { "$ref": "#/components/schemas/IPaymentPartReference" }, "primary_sale_session": { "$ref": "#/components/schemas/ISaleSessionReference" }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "BalanceType": { "enum": [ "FromValue", "ToValue", "Zero", "LessZero" ], "type": "string" }, "BankTerminal": { "required": [ "model", "terminal_id" ], "type": "object", "properties": { "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "model": { "maxLength": 24, "minLength": 1, "type": "string", "description": "model" }, "terminal_id": { "maxLength": 24, "minLength": 1, "type": "string", "description": "terminal_id" }, "merchant_id": { "maxLength": 24, "type": "string", "description": "merchant_id", "nullable": true }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "online_type": { "$ref": "#/components/schemas/PTOnlineType" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "BankTerminalPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BankTerminal" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "BankTransaction": { "required": [ "amount", "operation", "registered_at" ], "type": "object", "properties": { "authorization_code": { "maxLength": 16, "type": "string", "description": "authorization_code", "nullable": true }, "reference_retrieval_number": { "maxLength": 24, "type": "string", "description": "reference_retrieval_number", "nullable": true }, "emv_application_label": { "maxLength": 48, "type": "string", "description": "emv_application_label", "nullable": true }, "card_number": { "maxLength": 19, "type": "string", "description": "card_number", "nullable": true }, "cardholder_name": { "maxLength": 32, "type": "string", "description": "cardholder_name", "nullable": true }, "sources": { "$ref": "#/components/schemas/PTTransaction" }, "bank_terminal": { "$ref": "#/components/schemas/ITerminalBaseReference" }, "payment_type": { "$ref": "#/components/schemas/PTPaymentType" }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "amount": { "$ref": "#/components/schemas/Money" }, "registered_at": { "type": "string", "description": "registered_at", "format": "date-time" }, "operation": { "$ref": "#/components/schemas/TransactionOperationTypes" }, "transaction_type": { "$ref": "#/components/schemas/PTTransactionType" }, "status": { "$ref": "#/components/schemas/PTTransactionStatus" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "BankTransactionPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BankTransaction" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "Brand": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 32, "minLength": 2, "type": "string", "description": "name" }, "tagline": { "maxLength": 64, "minLength": 2, "type": "string", "description": "tagline", "nullable": true }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "BrandOrderings": { "enum": [ "created_at_asc", "created_at_desc", "updated_at_asc", "updated_at_desc", "name_asc", "name_desc" ], "type": "string" }, "BrandPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Brand" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "BrandReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "CaptchaType": { "enum": [ "YandexSmartCaptcha", "hCaptcha" ], "type": "string" }, "CardPaymentPart": { "required": [ "amount", "status" ], "type": "object", "properties": { "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/ITransactionBaseReference" }, "description": "transactions", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "amount": { "$ref": "#/components/schemas/Money" }, "status": { "$ref": "#/components/schemas/PaymentPartStatuses" }, "primary_payment_part": { "$ref": "#/components/schemas/IPaymentPartReference" }, "primary_sale_session": { "$ref": "#/components/schemas/ISaleSessionReference" }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "CashPaymentPart": { "required": [ "amount", "status" ], "type": "object", "properties": { "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "amount": { "$ref": "#/components/schemas/Money" }, "status": { "$ref": "#/components/schemas/PaymentPartStatuses" }, "primary_payment_part": { "$ref": "#/components/schemas/IPaymentPartReference" }, "primary_sale_session": { "$ref": "#/components/schemas/ISaleSessionReference" }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "CashlessPaymentPart": { "required": [ "amount", "status" ], "type": "object", "properties": { "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "amount": { "$ref": "#/components/schemas/Money" }, "status": { "$ref": "#/components/schemas/PaymentPartStatuses" }, "primary_payment_part": { "$ref": "#/components/schemas/IPaymentPartReference" }, "primary_sale_session": { "$ref": "#/components/schemas/ISaleSessionReference" }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "CheckCodeByPhone": { "required": [ "confirmation_code", "phone" ], "type": "object", "properties": { "phone": { "maxLength": 18, "minLength": 10, "pattern": "((8|\\+7)-?)?\\(?\\d{3,5}\\)?-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}((-?\\d{1})?-?\\d{1})?", "type": "string", "description": "phone" }, "confirmation_code": { "maxLength": 6, "minLength": 6, "pattern": "^\\d+$", "type": "string", "description": "confirmation_code" } }, "additionalProperties": false }, "CheckPhoneAvailabilityCredentials": { "required": [ "phone" ], "type": "object", "properties": { "phone": { "maxLength": 18, "minLength": 10, "pattern": "((8|\\+7)-?)?\\(?\\d{3,5}\\)?-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}((-?\\d{1})?-?\\d{1})?", "type": "string", "description": "phone" } }, "additionalProperties": false }, "CktHost": { "enum": [ "alfa", "vtb", "open", "metall", "bspb", "rshb" ], "type": "string" }, "CktSoftPOSOutletExtension": { "required": [ "app_package_name", "device_model", "device_vendor", "for_inn", "juridical_address", "juridical_name", "mid", "operator_email", "tids", "version" ], "type": "object", "properties": { "for_inn": { "minLength": 1, "type": "string", "description": "for_inn" }, "juridical_name": { "maxLength": 256, "minLength": 2, "type": "string", "description": "juridical_name" }, "juridical_address": { "maxLength": 256, "minLength": 2, "type": "string", "description": "juridical_address" }, "operator_email": { "maxLength": 92, "minLength": 6, "type": "string", "description": "operator_email", "format": "email" }, "mid": { "maxLength": 24, "minLength": 1, "type": "string", "description": "mid" }, "tids": { "maxLength": 24, "minLength": 1, "type": "array", "items": { "type": "string" }, "description": "tids" }, "host": { "$ref": "#/components/schemas/CktHost" }, "app_package_name": { "maxLength": 1024, "minLength": 1, "type": "string", "description": "app_package_name" }, "device_vendor": { "maxLength": 24, "minLength": 1, "type": "string", "description": "device_vendor" }, "device_model": { "maxLength": 24, "minLength": 1, "type": "string", "description": "device_model" }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "CloudFiscalizationExtension": { "required": [ "available_registrars", "version" ], "type": "object", "properties": { "turned_on": { "type": "boolean", "description": "turned_on", "default": true }, "available_registrars": { "type": "array", "items": { "$ref": "#/components/schemas/LifePayCloudFiscalRegistrar" }, "description": "available_registrars" }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "Company": { "type": "object", "properties": { "id": { "type": "string", "description": "id", "nullable": true }, "inn": { "type": "string", "description": "inn", "nullable": true }, "kpp": { "type": "string", "description": "kpp", "nullable": true }, "name": { "type": "string", "description": "name", "nullable": true } }, "additionalProperties": false }, "CorrectionData": { "required": [ "correction_type" ], "type": "object", "properties": { "correction_type": { "$ref": "#/components/schemas/FECorrectionTypes" }, "basis_for_correction": { "$ref": "#/components/schemas/FTCorrectionBasis" } }, "additionalProperties": false }, "CountryCodes": { "enum": [ "AFG", "ALB", "ATA", "DZA", "ASM", "AND", "AGO", "ATG", "AZE", "ARG", "AUS", "AUT", "BHS", "BHR", "BGD", "ARM", "BRB", "BEL", "BMU", "BTN", "BOL", "BIH", "BWA", "BVT", "BRA", "BLZ", "IOT", "SLB", "VGB", "BRN", "BGR", "MMR", "BDI", "BLR", "KHM", "CMR", "CAN", "CPV", "CYM", "CAF", "LKA", "TCD", "CHL", "CHN", "TWN", "CXR", "CCK", "COL", "COM", "MYT", "COG", "COD", "COK", "CRI", "HRV", "CUB", "CYP", "CZE", "BEN", "DNK", "DMA", "DOM", "ECU", "SLV", "GNQ", "ETH", "ERI", "EST", "FRO", "FLK", "SGS", "FJI", "FIN", "ALA", "FRA", "GUF", "PYF", "ATF", "DJI", "GAB", "GEO", "GMB", "PSE", "DEU", "GHA", "GIB", "KIR", "GRC", "GRL", "GRD", "GLP", "GUM", "GTM", "GIN", "GUY", "HTI", "HMD", "VAT", "HND", "HKG", "HUN", "ISL", "IND", "IDN", "IRN", "IRQ", "IRL", "ISR", "ITA", "CIV", "JAM", "JPN", "KAZ", "JOR", "KEN", "PRK", "KOR", "KWT", "KGZ", "LAO", "LBN", "LSO", "LVA", "LBR", "LBY", "LIE", "LTU", "LUX", "MAC", "MDG", "MWI", "MYS", "MDV", "MLI", "MLT", "MTQ", "MRT", "MUS", "MEX", "MCO", "MNG", "MDA", "MNE", "MSR", "MAR", "MOZ", "OMN", "NAM", "NRU", "NPL", "NLD", "CUW", "ABW", "SXM", "BES", "NCL", "VUT", "NZL", "NIC", "NER", "NGA", "NIU", "NFK", "NOR", "MNP", "UMI", "FSM", "MHL", "PLW", "PAK", "PAN", "PNG", "PRY", "PER", "PHL", "PCN", "POL", "PRT", "GNB", "TLS", "PRI", "QAT", "REU", "ROU", "RUS", "RWA", "BLM", "SHN", "KNA", "AIA", "LCA", "MAF", "SPM", "VCT", "SMR", "STP", "SAU", "SEN", "SRB", "SYC", "SLE", "SGP", "SVK", "VNM", "SVN", "SOM", "ZAF", "ZWE", "ESP", "SSD", "SDN", "ESH", "SUR", "SJM", "SWZ", "SWE", "CHE", "SYR", "TJK", "THA", "TGO", "TKL", "TON", "TTO", "ARE", "TUN", "TUR", "TKM", "TCA", "TUV", "UGA", "UKR", "MKD", "EGY", "GBR", "GGY", "JEY", "IMN", "TZA", "USA", "VIR", "BFA", "URY", "UZB", "VEN", "WLF", "WSM", "YEM", "ZMB" ], "type": "string" }, "CurrencyCodes": { "enum": [ "RUB", "GBP", "USD", "EUR", "Unknown" ], "type": "string" }, "CustomerData": { "type": "object", "properties": { "name": { "maxLength": 256, "type": "string", "description": "name", "nullable": true }, "inn": { "type": "string", "description": "inn", "nullable": true }, "contacts": { "maxLength": 64, "type": "string", "description": "contacts", "nullable": true }, "citizenship": { "$ref": "#/components/schemas/CountryCodes" }, "identity_document_type": { "$ref": "#/components/schemas/IdentityDocumentTypes" }, "identity_document_data": { "maxLength": 64, "type": "string", "description": "identity_document_data", "nullable": true }, "date_of_birth": { "type": "string", "description": "date_of_birth", "format": "date-time", "nullable": true }, "address": { "maxLength": 256, "type": "string", "description": "address", "nullable": true } }, "additionalProperties": false }, "DealOrderings": { "enum": [ "created_at_asc", "created_at_desc", "updated_at_asc", "updated_at_desc", "opened_at_asc", "opened_at_desc", "number_asc", "number_desc" ], "type": "string" }, "DealPaymentStatus": { "enum": [ "NotPaid", "Paid", "PartiallyPaid", "Refunded", "PartiallyRefunded" ], "type": "string" }, "DealPosition": { "required": [ "name", "quantity", "sale_price", "settlement_subject", "tax", "total_sum", "uom" ], "type": "object", "properties": { "settlement_subject": { "$ref": "#/components/schemas/SettlementSubjects" }, "name": { "maxLength": 128, "minLength": 1, "type": "string", "description": "name" }, "uom": { "$ref": "#/components/schemas/UomReference" }, "tax": { "$ref": "#/components/schemas/ValueAddedTaxRates" }, "sale_price": { "$ref": "#/components/schemas/Money" }, "quantity": { "type": "number", "description": "quantity", "format": "double" }, "made_in": { "$ref": "#/components/schemas/CountryCodes" }, "total_sum": { "$ref": "#/components/schemas/Money" }, "barcode": { "type": "string", "description": "barcode (__*Required__ when `is_markable=true`)", "nullable": true }, "is_markable": { "type": "boolean", "description": "is_markable", "readOnly": true }, "is_egais_markable": { "type": "boolean", "description": "is_egais_markable" }, "marking_attributes": { "$ref": "#/components/schemas/MarkingAttributes" }, "additional_attributes": { "$ref": "#/components/schemas/AdditionalDealPositionAttributes" }, "is_patent": { "type": "boolean", "description": "is_patent", "default": false, "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "DealPositionDiscountInfo": { "required": [ "deal_position_guid", "original_sale_price_value" ], "type": "object", "properties": { "deal_position_guid": { "type": "string", "description": "deal_position_guid", "format": "uuid" }, "sale_price_discount": { "$ref": "#/components/schemas/DiscountAmount" }, "original_sale_price_value": { "type": "integer", "description": "original_sale_price_value", "format": "int64" } }, "additionalProperties": false }, "DealPositionReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "DealShippingStatus": { "enum": [ "NotShipped", "Shipped", "PartiallyShipped", "Returned", "PartiallyReturned" ], "type": "string" }, "DealStates": { "enum": [ "New", "InProgress", "Completed", "Cancelled" ], "type": "string" }, "DefaultAddMethodRole": { "enum": [ "EmptyCart", "Catalog", "Scanner", "FreePosition" ], "type": "string" }, "DefaultOrderings": { "enum": [ "created_at_asc", "created_at_desc", "updated_at_asc", "updated_at_desc" ], "type": "string" }, "DirectCorrectionSaleSession": { "type": "object", "properties": { "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "correction_data": { "$ref": "#/components/schemas/CorrectionData" }, "sale": { "$ref": "#/components/schemas/SaleReference" }, "actions": { "$ref": "#/components/schemas/SaleActions" }, "fiscal_documents": { "type": "array", "items": { "$ref": "#/components/schemas/IFiscalDocumentReference" }, "description": "fiscal_documents", "nullable": true }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "DirectSaleSession": { "type": "object", "properties": { "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "sale": { "$ref": "#/components/schemas/SaleReference" }, "actions": { "$ref": "#/components/schemas/SaleActions" }, "fiscal_documents": { "type": "array", "items": { "$ref": "#/components/schemas/IFiscalDocumentReference" }, "description": "fiscal_documents", "nullable": true }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "DiscountAmount": { "required": [ "amount", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/DiscountAmountType" }, "amount": { "type": "integer", "description": "amount", "format": "int64" } }, "additionalProperties": false }, "DiscountAmountType": { "enum": [ "Absolute", "Percentage" ], "type": "string" }, "DiscountSettings": { "required": [ "turned_on" ], "type": "object", "properties": { "turned_on": { "type": "boolean", "description": "turned_on" }, "max_value_percentage": { "maximum": 99, "minimum": 1, "type": "integer", "description": "max_value_percentage", "format": "int32", "nullable": true } }, "additionalProperties": false }, "DiscountsOutletExtension": { "required": [ "version" ], "type": "object", "properties": { "manual_discount_settings": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DiscountSettings" }, "description": "manual_discount_settings" }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "DiscountsSaleExtension": { "required": [ "version" ], "type": "object", "properties": { "deal_position_discounts": { "type": "array", "items": { "$ref": "#/components/schemas/DealPositionDiscountInfo" }, "description": "deal_position_discounts", "nullable": true }, "sale_discount_percentage": { "type": "integer", "description": "sale_discount_percentage", "format": "int32", "nullable": true }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "Employee": { "required": [ "name", "phone", "role", "username" ], "type": "object", "properties": { "name": { "maxLength": 64, "minLength": 2, "type": "string", "description": "name" }, "username": { "maxLength": 24, "minLength": 2, "type": "string", "description": "username" }, "phone": { "maxLength": 18, "minLength": 10, "pattern": "((8|\\+7)-?)?\\(?\\d{3,5}\\)?-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}((-?\\d{1})?-?\\d{1})?", "type": "string", "description": "phone" }, "role": { "$ref": "#/components/schemas/RoleReference" }, "inn": { "maxLength": 12, "minLength": 12, "pattern": "^\\d+$", "type": "string", "description": "inn", "nullable": true }, "pin_code_hash": { "maxLength": 32, "minLength": 32, "type": "string", "description": "pin_code_hash", "nullable": true }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "email": { "maxLength": 64, "minLength": 6, "type": "string", "description": "email", "format": "email", "nullable": true }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "EmployeeOrderings": { "enum": [ "created_at_asc", "created_at_desc", "updated_at_asc", "updated_at_desc", "name_asc", "name_desc" ], "type": "string" }, "EmployeePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Employee" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "EmployeeReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "Error": { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/ErrorCodes" }, "message": { "type": "string", "description": "message", "nullable": true }, "info": { "type": "string", "description": "info", "nullable": true } }, "additionalProperties": false }, "ErrorCodes": { "enum": [ "InternalServerError", "TooManyRequests", "RequestIsNotValid", "BadRequest", "NoPermissions", "Unauthorized", "NotFound", "ReferenceNotFound", "Duplicate", "NotUnique", "NotNullOrUnique", "NotAllowed", "NotAllowedForArchived", "TryLater", "OperationCannotBePerformed", "NotificationsAreOutOfService", "TrySendCodeLater", "UsernameIsAlreadyTaken", "PhoneIsNotFound", "PhoneIsNotFoundInOrganization", "PhoneIsAlreadyTaken", "InvalidConfirmationCode", "ConfirmationCodeWasCanceled", "ConfirmationCodeWasNotSend", "UsernameDoesNotExist", "WrongUsernameOrPassword", "WrongActivationCode", "TryActivateLater", "AliasIsNotFound", "AliasIsAlreadyTaken", "NotAllowedForOwner", "DealPositionHasInvalidQuantity", "CheckMarkingCodeMustBeDisabled", "LegalEntityCrptTokenNotSpecified" ], "type": "string" }, "ExternalDiscountCalculatorOutletExtension": { "required": [ "timeout", "turned_on", "url", "version" ], "type": "object", "properties": { "usage_variant": { "$ref": "#/components/schemas/ExternalDiscountCalculatorUsageVariants" }, "wifi_hotspot": { "maxLength": 64, "type": "string", "description": "wifi_hotspot", "nullable": true }, "url": { "minLength": 1, "type": "string", "description": "url", "format": "uri" }, "timeout": { "maximum": 60000, "minimum": 100, "type": "integer", "description": "timeout", "format": "int32" }, "turned_on": { "type": "boolean", "description": "turned_on" }, "http_headers": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "http_headers", "nullable": true }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "ExternalDiscountCalculatorUsageVariants": { "enum": [ "Internet", "WiFi", "SpecifiedWiFi" ], "type": "string" }, "FCAdditionalAttribute": { "type": "object", "properties": { "name": { "maxLength": 128, "type": "string", "description": "name", "nullable": true }, "value": { "maxLength": 1024, "type": "string", "description": "value", "nullable": true } }, "additionalProperties": false }, "FDFiscalDriveClosingReport": { "type": "object", "properties": { "fiscal_document_name": { "type": "string", "description": "fiscal_document_name", "nullable": true, "readOnly": true }, "fiscal_document_form": { "$ref": "#/components/schemas/FEFiscalForms" }, "shift_number": { "type": "integer", "description": "shift_number", "format": "int32", "nullable": true }, "fiscal_drive_total_counters": { "$ref": "#/components/schemas/FTTotalCounters" }, "additional_attribute": { "maxLength": 32, "type": "string", "description": "additional_attribute", "nullable": true }, "additional_data": { "maxLength": 32, "type": "string", "description": "additional_data", "format": "byte", "nullable": true }, "fiscal_document_format": { "$ref": "#/components/schemas/FEFiscalFormats" }, "organization_name": { "maxLength": 256, "type": "string", "description": "organization_name", "nullable": true }, "organization_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "organization_inn", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar_registration_number": { "maxLength": 20, "minLength": 0, "type": "string", "description": "fiscal_registrar_registration_number", "nullable": true }, "fiscal_registrar_serial_number": { "type": "string", "description": "fiscal_registrar_serial_number", "nullable": true }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "cashier_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "cashier_inn", "nullable": true }, "settlement_address": { "maxLength": 256, "type": "string", "description": "settlement_address", "nullable": true }, "settlement_location": { "maxLength": 256, "type": "string", "description": "settlement_location", "nullable": true }, "fiscal_document_number": { "type": "integer", "description": "fiscal_document_number", "format": "int32" }, "fiscal_drive_number": { "maxLength": 16, "minLength": 0, "type": "string", "description": "fiscal_drive_number", "nullable": true }, "fiscal_sign": { "type": "integer", "description": "fiscal_sign", "format": "int64", "nullable": true }, "additional_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FCAdditionalAttribute" }, "description": "additional_attributes", "nullable": true }, "print_mode": { "$ref": "#/components/schemas/FDPrintMode" }, "ofd_url": { "type": "string", "description": "ofd_url", "nullable": true }, "external_id": { "type": "string", "description": "external_id", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FDOperatorConfirmation": { "type": "object", "properties": { "fiscal_document_name": { "type": "string", "description": "fiscal_document_name", "nullable": true, "readOnly": true }, "fiscal_document_form": { "$ref": "#/components/schemas/FEFiscalForms" }, "ofd_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "ofd_inn", "nullable": true }, "ofd_messages": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FEOfdMessages" }, "description": "ofd_messages", "nullable": true }, "fiscal_document_format": { "$ref": "#/components/schemas/FEFiscalFormats" }, "organization_name": { "maxLength": 256, "type": "string", "description": "organization_name", "nullable": true }, "organization_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "organization_inn", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar_registration_number": { "maxLength": 20, "minLength": 0, "type": "string", "description": "fiscal_registrar_registration_number", "nullable": true }, "fiscal_registrar_serial_number": { "type": "string", "description": "fiscal_registrar_serial_number", "nullable": true }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "cashier_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "cashier_inn", "nullable": true }, "settlement_address": { "maxLength": 256, "type": "string", "description": "settlement_address", "nullable": true }, "settlement_location": { "maxLength": 256, "type": "string", "description": "settlement_location", "nullable": true }, "fiscal_document_number": { "type": "integer", "description": "fiscal_document_number", "format": "int32" }, "fiscal_drive_number": { "maxLength": 16, "minLength": 0, "type": "string", "description": "fiscal_drive_number", "nullable": true }, "fiscal_sign": { "type": "integer", "description": "fiscal_sign", "format": "int64", "nullable": true }, "additional_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FCAdditionalAttribute" }, "description": "additional_attributes", "nullable": true }, "print_mode": { "$ref": "#/components/schemas/FDPrintMode" }, "ofd_url": { "type": "string", "description": "ofd_url", "nullable": true }, "external_id": { "type": "string", "description": "external_id", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FDPrintMode": { "enum": [ "Print", "Email", "PrintEmail" ], "type": "string" }, "FDReRegistrationReport": { "type": "object", "properties": { "fiscal_document_name": { "type": "string", "description": "fiscal_document_name", "nullable": true, "readOnly": true }, "fiscal_document_form": { "$ref": "#/components/schemas/FEFiscalForms" }, "reasons": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FEReRegistrationReasons" }, "description": "reasons", "nullable": true }, "fiscal_drive_total_counters": { "$ref": "#/components/schemas/FTTotalCounters" }, "tax_systems": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TaxSystems" }, "description": "tax_systems", "nullable": true }, "used_in_autonomous_mode": { "type": "boolean", "description": "used_in_autonomous_mode", "nullable": true }, "uses_encryption": { "type": "boolean", "description": "uses_encryption", "nullable": true }, "used_in_automatic_mode": { "type": "boolean", "description": "used_in_automatic_mode", "nullable": true }, "machine_number": { "maxLength": 20, "type": "string", "description": "machine_number", "nullable": true }, "federal_tax_service_url": { "maxLength": 256, "type": "string", "description": "federal_tax_service_url", "nullable": true }, "receipt_sender_email": { "maxLength": 64, "type": "string", "description": "receipt_sender_email", "nullable": true }, "ofd_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "ofd_inn", "nullable": true }, "ofd_name": { "maxLength": 256, "type": "string", "description": "ofd_name", "nullable": true }, "fiscal_registrar_version": { "maxLength": 3, "type": "string", "description": "fiscal_registrar_version", "nullable": true }, "fiscal_registrar_format": { "$ref": "#/components/schemas/FEFiscalFormats" }, "fiscal_drive_format": { "$ref": "#/components/schemas/FEFiscalFormats" }, "fiscal_sign_keys_resource": { "type": "integer", "description": "fiscal_sign_keys_resource", "format": "int32", "nullable": true }, "fiscal_registrar_using_conditions": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FEFiscalRegistrarUsingConditions" }, "description": "fiscal_registrar_using_conditions", "nullable": true }, "additional_attribute": { "maxLength": 32, "type": "string", "description": "additional_attribute", "nullable": true }, "additional_data": { "type": "string", "description": "additional_data", "format": "byte", "nullable": true }, "fiscal_document_format": { "$ref": "#/components/schemas/FEFiscalFormats" }, "organization_name": { "maxLength": 256, "type": "string", "description": "organization_name", "nullable": true }, "organization_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "organization_inn", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar_registration_number": { "maxLength": 20, "minLength": 0, "type": "string", "description": "fiscal_registrar_registration_number", "nullable": true }, "fiscal_registrar_serial_number": { "type": "string", "description": "fiscal_registrar_serial_number", "nullable": true }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "cashier_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "cashier_inn", "nullable": true }, "settlement_address": { "maxLength": 256, "type": "string", "description": "settlement_address", "nullable": true }, "settlement_location": { "maxLength": 256, "type": "string", "description": "settlement_location", "nullable": true }, "fiscal_document_number": { "type": "integer", "description": "fiscal_document_number", "format": "int32" }, "fiscal_drive_number": { "maxLength": 16, "minLength": 0, "type": "string", "description": "fiscal_drive_number", "nullable": true }, "fiscal_sign": { "type": "integer", "description": "fiscal_sign", "format": "int64", "nullable": true }, "additional_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FCAdditionalAttribute" }, "description": "additional_attributes", "nullable": true }, "print_mode": { "$ref": "#/components/schemas/FDPrintMode" }, "ofd_url": { "type": "string", "description": "ofd_url", "nullable": true }, "external_id": { "type": "string", "description": "external_id", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FDReceipt": { "type": "object", "properties": { "fiscal_document_name": { "type": "string", "description": "fiscal_document_name", "nullable": true, "readOnly": true }, "fiscal_document_form": { "$ref": "#/components/schemas/FEFiscalForms" }, "customer_data": { "$ref": "#/components/schemas/FTCustomerData" }, "receipt_number": { "type": "integer", "description": "receipt_number", "format": "int32" }, "shift_number": { "type": "integer", "description": "shift_number", "format": "int32" }, "operation_type": { "$ref": "#/components/schemas/FEOperationTypes" }, "tax_system": { "$ref": "#/components/schemas/TaxSystems" }, "machine_number": { "maxLength": 20, "type": "string", "description": "machine_number", "nullable": true }, "customer_contacts": { "maxLength": 64, "type": "string", "description": "customer_contacts", "nullable": true }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/FTReceiptPosition" }, "description": "positions", "nullable": true }, "total_sum": { "type": "integer", "description": "total_sum", "format": "int64", "nullable": true }, "sum_by_cash": { "type": "integer", "description": "sum_by_cash", "format": "int64" }, "sum_by_card": { "type": "integer", "description": "sum_by_card", "format": "int64" }, "sum_by_prepayment": { "type": "integer", "description": "sum_by_prepayment", "format": "int64" }, "sum_by_postpayment": { "type": "integer", "description": "sum_by_postpayment", "format": "int64" }, "sum_by_considerations": { "type": "integer", "description": "sum_by_considerations", "format": "int64" }, "sum_of_vat_1102": { "type": "integer", "description": "sum_of_vat_1102", "format": "int64", "nullable": true }, "sum_of_vat_1103": { "type": "integer", "description": "sum_of_vat_1103", "format": "int64", "nullable": true }, "sum_of_vat_1104": { "type": "integer", "description": "sum_of_vat_1104", "format": "int64", "nullable": true }, "sum_of_vat_1105": { "type": "integer", "description": "sum_of_vat_1105", "format": "int64", "nullable": true }, "sum_of_vat_1106": { "type": "integer", "description": "sum_of_vat_1106", "format": "int64", "nullable": true }, "sum_of_vat_1107": { "type": "integer", "description": "sum_of_vat_1107", "format": "int64", "nullable": true }, "used_for_internet_only": { "type": "boolean", "description": "used_for_internet_only", "nullable": true }, "receipt_sender_email": { "maxLength": 64, "type": "string", "description": "receipt_sender_email", "nullable": true }, "results_of_checking_marked_positions": { "type": "boolean", "description": "results_of_checking_marked_positions", "nullable": true }, "federal_tax_service_url": { "maxLength": 256, "type": "string", "description": "federal_tax_service_url", "nullable": true }, "operational_receipt_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FTOperatingReceiptAttribute" }, "description": "operational_receipt_attributes", "nullable": true }, "additional_receipt_attribute": { "maxLength": 16, "type": "string", "description": "additional_receipt_attribute", "nullable": true }, "additional_user_attribute": { "$ref": "#/components/schemas/FTAdditionalAttribute" }, "industry_receipt_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FTIndustryAttribute" }, "description": "industry_receipt_attributes", "nullable": true }, "qr_code": { "type": "string", "description": "qr_code", "nullable": true }, "print_view": { "maxLength": 32768, "type": "string", "description": "print_view", "nullable": true }, "vat_receipt_total": { "type": "array", "items": { "$ref": "#/components/schemas/FEVatReceiptItem" }, "description": "vat_receipt_total", "nullable": true }, "is_internet_payment": { "type": "boolean", "description": "is_internet_payment", "nullable": true }, "fiscal_document_format": { "$ref": "#/components/schemas/FEFiscalFormats" }, "organization_name": { "maxLength": 256, "type": "string", "description": "organization_name", "nullable": true }, "organization_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "organization_inn", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar_registration_number": { "maxLength": 20, "minLength": 0, "type": "string", "description": "fiscal_registrar_registration_number", "nullable": true }, "fiscal_registrar_serial_number": { "type": "string", "description": "fiscal_registrar_serial_number", "nullable": true }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "cashier_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "cashier_inn", "nullable": true }, "settlement_address": { "maxLength": 256, "type": "string", "description": "settlement_address", "nullable": true }, "settlement_location": { "maxLength": 256, "type": "string", "description": "settlement_location", "nullable": true }, "fiscal_document_number": { "type": "integer", "description": "fiscal_document_number", "format": "int32" }, "fiscal_drive_number": { "maxLength": 16, "minLength": 0, "type": "string", "description": "fiscal_drive_number", "nullable": true }, "fiscal_sign": { "type": "integer", "description": "fiscal_sign", "format": "int64", "nullable": true }, "additional_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FCAdditionalAttribute" }, "description": "additional_attributes", "nullable": true }, "print_mode": { "$ref": "#/components/schemas/FDPrintMode" }, "ofd_url": { "type": "string", "description": "ofd_url", "nullable": true }, "external_id": { "type": "string", "description": "external_id", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FDReceiptOfCorrection": { "type": "object", "properties": { "fiscal_document_name": { "type": "string", "description": "fiscal_document_name", "nullable": true, "readOnly": true }, "fiscal_document_form": { "$ref": "#/components/schemas/FEFiscalForms" }, "correction_type": { "$ref": "#/components/schemas/FECorrectionTypes" }, "basis_for_correction": { "$ref": "#/components/schemas/FTCorrectionBasis" }, "customer_data": { "$ref": "#/components/schemas/FTCustomerData" }, "receipt_number": { "type": "integer", "description": "receipt_number", "format": "int32" }, "shift_number": { "type": "integer", "description": "shift_number", "format": "int32" }, "operation_type": { "$ref": "#/components/schemas/FEOperationTypes" }, "tax_system": { "$ref": "#/components/schemas/TaxSystems" }, "machine_number": { "maxLength": 20, "type": "string", "description": "machine_number", "nullable": true }, "customer_contacts": { "maxLength": 64, "type": "string", "description": "customer_contacts", "nullable": true }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/FTReceiptPosition" }, "description": "positions", "nullable": true }, "total_sum": { "type": "integer", "description": "total_sum", "format": "int64", "nullable": true }, "sum_by_cash": { "type": "integer", "description": "sum_by_cash", "format": "int64" }, "sum_by_card": { "type": "integer", "description": "sum_by_card", "format": "int64" }, "sum_by_prepayment": { "type": "integer", "description": "sum_by_prepayment", "format": "int64" }, "sum_by_postpayment": { "type": "integer", "description": "sum_by_postpayment", "format": "int64" }, "sum_by_considerations": { "type": "integer", "description": "sum_by_considerations", "format": "int64" }, "sum_of_vat_1102": { "type": "integer", "description": "sum_of_vat_1102", "format": "int64", "nullable": true }, "sum_of_vat_1103": { "type": "integer", "description": "sum_of_vat_1103", "format": "int64", "nullable": true }, "sum_of_vat_1104": { "type": "integer", "description": "sum_of_vat_1104", "format": "int64", "nullable": true }, "sum_of_vat_1105": { "type": "integer", "description": "sum_of_vat_1105", "format": "int64", "nullable": true }, "sum_of_vat_1106": { "type": "integer", "description": "sum_of_vat_1106", "format": "int64", "nullable": true }, "sum_of_vat_1107": { "type": "integer", "description": "sum_of_vat_1107", "format": "int64", "nullable": true }, "used_for_internet_only": { "type": "boolean", "description": "used_for_internet_only", "nullable": true }, "receipt_sender_email": { "maxLength": 64, "type": "string", "description": "receipt_sender_email", "nullable": true }, "results_of_checking_marked_positions": { "type": "boolean", "description": "results_of_checking_marked_positions", "nullable": true }, "federal_tax_service_url": { "maxLength": 256, "type": "string", "description": "federal_tax_service_url", "nullable": true }, "operational_receipt_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FTOperatingReceiptAttribute" }, "description": "operational_receipt_attributes", "nullable": true }, "additional_receipt_attribute": { "maxLength": 16, "type": "string", "description": "additional_receipt_attribute", "nullable": true }, "additional_user_attribute": { "$ref": "#/components/schemas/FTAdditionalAttribute" }, "industry_receipt_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FTIndustryAttribute" }, "description": "industry_receipt_attributes", "nullable": true }, "qr_code": { "type": "string", "description": "qr_code", "nullable": true }, "print_view": { "maxLength": 32768, "type": "string", "description": "print_view", "nullable": true }, "vat_receipt_total": { "type": "array", "items": { "$ref": "#/components/schemas/FEVatReceiptItem" }, "description": "vat_receipt_total", "nullable": true }, "is_internet_payment": { "type": "boolean", "description": "is_internet_payment", "nullable": true }, "fiscal_document_format": { "$ref": "#/components/schemas/FEFiscalFormats" }, "organization_name": { "maxLength": 256, "type": "string", "description": "organization_name", "nullable": true }, "organization_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "organization_inn", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar_registration_number": { "maxLength": 20, "minLength": 0, "type": "string", "description": "fiscal_registrar_registration_number", "nullable": true }, "fiscal_registrar_serial_number": { "type": "string", "description": "fiscal_registrar_serial_number", "nullable": true }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "cashier_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "cashier_inn", "nullable": true }, "settlement_address": { "maxLength": 256, "type": "string", "description": "settlement_address", "nullable": true }, "settlement_location": { "maxLength": 256, "type": "string", "description": "settlement_location", "nullable": true }, "fiscal_document_number": { "type": "integer", "description": "fiscal_document_number", "format": "int32" }, "fiscal_drive_number": { "maxLength": 16, "minLength": 0, "type": "string", "description": "fiscal_drive_number", "nullable": true }, "fiscal_sign": { "type": "integer", "description": "fiscal_sign", "format": "int64", "nullable": true }, "additional_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FCAdditionalAttribute" }, "description": "additional_attributes", "nullable": true }, "print_mode": { "$ref": "#/components/schemas/FDPrintMode" }, "ofd_url": { "type": "string", "description": "ofd_url", "nullable": true }, "external_id": { "type": "string", "description": "external_id", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FDRegistrationReport": { "type": "object", "properties": { "fiscal_document_name": { "type": "string", "description": "fiscal_document_name", "nullable": true, "readOnly": true }, "fiscal_document_form": { "$ref": "#/components/schemas/FEFiscalForms" }, "tax_systems": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TaxSystems" }, "description": "tax_systems", "nullable": true }, "used_in_autonomous_mode": { "type": "boolean", "description": "used_in_autonomous_mode", "nullable": true }, "uses_encryption": { "type": "boolean", "description": "uses_encryption", "nullable": true }, "used_in_automatic_mode": { "type": "boolean", "description": "used_in_automatic_mode", "nullable": true }, "machine_number": { "maxLength": 20, "type": "string", "description": "machine_number", "nullable": true }, "federal_tax_service_url": { "maxLength": 256, "type": "string", "description": "federal_tax_service_url", "nullable": true }, "receipt_sender_email": { "maxLength": 64, "type": "string", "description": "receipt_sender_email", "nullable": true }, "ofd_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "ofd_inn", "nullable": true }, "ofd_name": { "maxLength": 256, "type": "string", "description": "ofd_name", "nullable": true }, "fiscal_registrar_version": { "maxLength": 3, "type": "string", "description": "fiscal_registrar_version", "nullable": true }, "fiscal_registrar_format": { "$ref": "#/components/schemas/FEFiscalFormats" }, "fiscal_drive_format": { "$ref": "#/components/schemas/FEFiscalFormats" }, "fiscal_sign_keys_resource": { "type": "integer", "description": "fiscal_sign_keys_resource", "format": "int32", "nullable": true }, "fiscal_registrar_using_conditions": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FEFiscalRegistrarUsingConditions" }, "description": "fiscal_registrar_using_conditions", "nullable": true }, "additional_attribute": { "maxLength": 32, "type": "string", "description": "additional_attribute", "nullable": true }, "additional_data": { "type": "string", "description": "additional_data", "format": "byte", "nullable": true }, "fiscal_document_format": { "$ref": "#/components/schemas/FEFiscalFormats" }, "organization_name": { "maxLength": 256, "type": "string", "description": "organization_name", "nullable": true }, "organization_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "organization_inn", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar_registration_number": { "maxLength": 20, "minLength": 0, "type": "string", "description": "fiscal_registrar_registration_number", "nullable": true }, "fiscal_registrar_serial_number": { "type": "string", "description": "fiscal_registrar_serial_number", "nullable": true }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "cashier_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "cashier_inn", "nullable": true }, "settlement_address": { "maxLength": 256, "type": "string", "description": "settlement_address", "nullable": true }, "settlement_location": { "maxLength": 256, "type": "string", "description": "settlement_location", "nullable": true }, "fiscal_document_number": { "type": "integer", "description": "fiscal_document_number", "format": "int32" }, "fiscal_drive_number": { "maxLength": 16, "minLength": 0, "type": "string", "description": "fiscal_drive_number", "nullable": true }, "fiscal_sign": { "type": "integer", "description": "fiscal_sign", "format": "int64", "nullable": true }, "additional_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FCAdditionalAttribute" }, "description": "additional_attributes", "nullable": true }, "print_mode": { "$ref": "#/components/schemas/FDPrintMode" }, "ofd_url": { "type": "string", "description": "ofd_url", "nullable": true }, "external_id": { "type": "string", "description": "external_id", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FDSettlementReport": { "type": "object", "properties": { "fiscal_document_name": { "type": "string", "description": "fiscal_document_name", "nullable": true, "readOnly": true }, "fiscal_document_form": { "$ref": "#/components/schemas/FEFiscalForms" }, "used_in_autonomous_mode": { "type": "boolean", "description": "used_in_autonomous_mode", "nullable": true }, "shift_number": { "type": "integer", "description": "shift_number", "format": "int32", "nullable": true }, "unsent_to_ofd_documents_count": { "type": "integer", "description": "unsent_to_ofd_documents_count", "format": "int32", "nullable": true }, "first_unsent_to_ofd_document_was_issued_at": { "type": "string", "description": "first_unsent_to_ofd_document_was_issued_at", "format": "date-time", "nullable": true }, "first_unsent_to_ofd_document_number": { "type": "integer", "description": "first_unsent_to_ofd_document_number", "format": "int32", "nullable": true }, "fiscal_drive_total_counters": { "$ref": "#/components/schemas/FTTotalCounters" }, "unsent_to_ofd_counters": { "$ref": "#/components/schemas/FTCorrectionCounters" }, "unsent_to_ofd_notifications_count": { "type": "integer", "description": "unsent_to_ofd_notifications_count", "format": "int32", "nullable": true }, "fiscal_sign_keys_resource": { "type": "integer", "description": "fiscal_sign_keys_resource", "format": "int32", "nullable": true }, "additional_attribute": { "maxLength": 32, "type": "string", "description": "additional_attribute", "nullable": true }, "additional_data": { "type": "string", "description": "additional_data", "format": "byte", "nullable": true }, "fiscal_document_format": { "$ref": "#/components/schemas/FEFiscalFormats" }, "organization_name": { "maxLength": 256, "type": "string", "description": "organization_name", "nullable": true }, "organization_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "organization_inn", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar_registration_number": { "maxLength": 20, "minLength": 0, "type": "string", "description": "fiscal_registrar_registration_number", "nullable": true }, "fiscal_registrar_serial_number": { "type": "string", "description": "fiscal_registrar_serial_number", "nullable": true }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "cashier_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "cashier_inn", "nullable": true }, "settlement_address": { "maxLength": 256, "type": "string", "description": "settlement_address", "nullable": true }, "settlement_location": { "maxLength": 256, "type": "string", "description": "settlement_location", "nullable": true }, "fiscal_document_number": { "type": "integer", "description": "fiscal_document_number", "format": "int32" }, "fiscal_drive_number": { "maxLength": 16, "minLength": 0, "type": "string", "description": "fiscal_drive_number", "nullable": true }, "fiscal_sign": { "type": "integer", "description": "fiscal_sign", "format": "int64", "nullable": true }, "additional_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FCAdditionalAttribute" }, "description": "additional_attributes", "nullable": true }, "print_mode": { "$ref": "#/components/schemas/FDPrintMode" }, "ofd_url": { "type": "string", "description": "ofd_url", "nullable": true }, "external_id": { "type": "string", "description": "external_id", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FDShiftClosingReport": { "type": "object", "properties": { "fiscal_document_name": { "type": "string", "description": "fiscal_document_name", "nullable": true, "readOnly": true }, "fiscal_document_form": { "$ref": "#/components/schemas/FEFiscalForms" }, "receipts_per_shift_count": { "type": "integer", "description": "receipts_per_shift_count", "format": "int32", "nullable": true }, "documents_per_shift_count": { "type": "integer", "description": "documents_per_shift_count", "format": "int32", "nullable": true }, "unsent_to_ofd_documents_count": { "type": "integer", "description": "unsent_to_ofd_documents_count", "format": "int32", "nullable": true }, "first_unsent_to_ofd_document_was_issued_at": { "type": "string", "description": "first_unsent_to_ofd_document_was_issued_at", "format": "date-time", "nullable": true }, "shift_total_counters": { "$ref": "#/components/schemas/FTTotalCounters" }, "fiscal_drive_total_counters": { "$ref": "#/components/schemas/FTTotalCounters" }, "fiscal_sign_keys_resource": { "type": "integer", "description": "fiscal_sign_keys_resource", "format": "int32", "nullable": true }, "not_valid_codes_sign": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FESignsOfNotValidCodes" }, "description": "not_valid_codes_sign", "nullable": true }, "not_valid_requests_and_notifications_sign": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FESignsOfNotValidRequestsAndNotifications" }, "description": "not_valid_requests_and_notifications_sign", "nullable": true }, "additional_attribute": { "maxLength": 32, "type": "string", "description": "additional_attribute", "nullable": true }, "additional_data": { "type": "string", "description": "additional_data", "format": "byte", "nullable": true }, "unsent_to_ofd_notifications_count": { "type": "integer", "description": "unsent_to_ofd_notifications_count", "format": "int32", "nullable": true }, "shift_number": { "type": "integer", "description": "shift_number", "format": "int32" }, "ofd_timeout_is_expired": { "type": "boolean", "description": "ofd_timeout_is_expired", "nullable": true }, "fiscal_drive_replacement_is_required": { "type": "boolean", "description": "fiscal_drive_replacement_is_required", "nullable": true }, "fiscal_drive_memory_is_overflowed": { "type": "boolean", "description": "fiscal_drive_memory_is_overflowed", "nullable": true }, "fiscal_drive_resource_is_exhausted": { "type": "boolean", "description": "fiscal_drive_resource_is_exhausted", "nullable": true }, "ofd_messages": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FEOfdMessages" }, "description": "ofd_messages", "nullable": true }, "fiscal_document_format": { "$ref": "#/components/schemas/FEFiscalFormats" }, "organization_name": { "maxLength": 256, "type": "string", "description": "organization_name", "nullable": true }, "organization_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "organization_inn", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar_registration_number": { "maxLength": 20, "minLength": 0, "type": "string", "description": "fiscal_registrar_registration_number", "nullable": true }, "fiscal_registrar_serial_number": { "type": "string", "description": "fiscal_registrar_serial_number", "nullable": true }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "cashier_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "cashier_inn", "nullable": true }, "settlement_address": { "maxLength": 256, "type": "string", "description": "settlement_address", "nullable": true }, "settlement_location": { "maxLength": 256, "type": "string", "description": "settlement_location", "nullable": true }, "fiscal_document_number": { "type": "integer", "description": "fiscal_document_number", "format": "int32" }, "fiscal_drive_number": { "maxLength": 16, "minLength": 0, "type": "string", "description": "fiscal_drive_number", "nullable": true }, "fiscal_sign": { "type": "integer", "description": "fiscal_sign", "format": "int64", "nullable": true }, "additional_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FCAdditionalAttribute" }, "description": "additional_attributes", "nullable": true }, "print_mode": { "$ref": "#/components/schemas/FDPrintMode" }, "ofd_url": { "type": "string", "description": "ofd_url", "nullable": true }, "external_id": { "type": "string", "description": "external_id", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FDShiftOpeningReport": { "type": "object", "properties": { "fiscal_document_name": { "type": "string", "description": "fiscal_document_name", "nullable": true, "readOnly": true }, "fiscal_document_form": { "$ref": "#/components/schemas/FEFiscalForms" }, "fiscal_registrar_version": { "maxLength": 3, "type": "string", "description": "fiscal_registrar_version", "nullable": true }, "fiscal_registrar_format": { "$ref": "#/components/schemas/FEFiscalFormats" }, "additional_attribute": { "maxLength": 32, "type": "string", "description": "additional_attribute", "nullable": true }, "additional_data": { "type": "string", "description": "additional_data", "format": "byte", "nullable": true }, "shift_number": { "type": "integer", "description": "shift_number", "format": "int32" }, "ofd_timeout_is_expired": { "type": "boolean", "description": "ofd_timeout_is_expired", "nullable": true }, "fiscal_drive_replacement_is_required": { "type": "boolean", "description": "fiscal_drive_replacement_is_required", "nullable": true }, "fiscal_drive_memory_is_overflowed": { "type": "boolean", "description": "fiscal_drive_memory_is_overflowed", "nullable": true }, "fiscal_drive_resource_is_exhausted": { "type": "boolean", "description": "fiscal_drive_resource_is_exhausted", "nullable": true }, "ofd_messages": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FEOfdMessages" }, "description": "ofd_messages", "nullable": true }, "fiscal_document_format": { "$ref": "#/components/schemas/FEFiscalFormats" }, "organization_name": { "maxLength": 256, "type": "string", "description": "organization_name", "nullable": true }, "organization_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "organization_inn", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar_registration_number": { "maxLength": 20, "minLength": 0, "type": "string", "description": "fiscal_registrar_registration_number", "nullable": true }, "fiscal_registrar_serial_number": { "type": "string", "description": "fiscal_registrar_serial_number", "nullable": true }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "cashier_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "cashier_inn", "nullable": true }, "settlement_address": { "maxLength": 256, "type": "string", "description": "settlement_address", "nullable": true }, "settlement_location": { "maxLength": 256, "type": "string", "description": "settlement_location", "nullable": true }, "fiscal_document_number": { "type": "integer", "description": "fiscal_document_number", "format": "int32" }, "fiscal_drive_number": { "maxLength": 16, "minLength": 0, "type": "string", "description": "fiscal_drive_number", "nullable": true }, "fiscal_sign": { "type": "integer", "description": "fiscal_sign", "format": "int64", "nullable": true }, "additional_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FCAdditionalAttribute" }, "description": "additional_attributes", "nullable": true }, "print_mode": { "$ref": "#/components/schemas/FDPrintMode" }, "ofd_url": { "type": "string", "description": "ofd_url", "nullable": true }, "external_id": { "type": "string", "description": "external_id", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FDStrictForm": { "type": "object", "properties": { "fiscal_document_name": { "type": "string", "description": "fiscal_document_name", "nullable": true, "readOnly": true }, "fiscal_document_form": { "$ref": "#/components/schemas/FEFiscalForms" }, "customer_data": { "$ref": "#/components/schemas/FTCustomerData" }, "receipt_number": { "type": "integer", "description": "receipt_number", "format": "int32" }, "shift_number": { "type": "integer", "description": "shift_number", "format": "int32" }, "operation_type": { "$ref": "#/components/schemas/FEOperationTypes" }, "tax_system": { "$ref": "#/components/schemas/TaxSystems" }, "machine_number": { "maxLength": 20, "type": "string", "description": "machine_number", "nullable": true }, "customer_contacts": { "maxLength": 64, "type": "string", "description": "customer_contacts", "nullable": true }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/FTReceiptPosition" }, "description": "positions", "nullable": true }, "total_sum": { "type": "integer", "description": "total_sum", "format": "int64", "nullable": true }, "sum_by_cash": { "type": "integer", "description": "sum_by_cash", "format": "int64" }, "sum_by_card": { "type": "integer", "description": "sum_by_card", "format": "int64" }, "sum_by_prepayment": { "type": "integer", "description": "sum_by_prepayment", "format": "int64" }, "sum_by_postpayment": { "type": "integer", "description": "sum_by_postpayment", "format": "int64" }, "sum_by_considerations": { "type": "integer", "description": "sum_by_considerations", "format": "int64" }, "sum_of_vat_1102": { "type": "integer", "description": "sum_of_vat_1102", "format": "int64", "nullable": true }, "sum_of_vat_1103": { "type": "integer", "description": "sum_of_vat_1103", "format": "int64", "nullable": true }, "sum_of_vat_1104": { "type": "integer", "description": "sum_of_vat_1104", "format": "int64", "nullable": true }, "sum_of_vat_1105": { "type": "integer", "description": "sum_of_vat_1105", "format": "int64", "nullable": true }, "sum_of_vat_1106": { "type": "integer", "description": "sum_of_vat_1106", "format": "int64", "nullable": true }, "sum_of_vat_1107": { "type": "integer", "description": "sum_of_vat_1107", "format": "int64", "nullable": true }, "used_for_internet_only": { "type": "boolean", "description": "used_for_internet_only", "nullable": true }, "receipt_sender_email": { "maxLength": 64, "type": "string", "description": "receipt_sender_email", "nullable": true }, "results_of_checking_marked_positions": { "type": "boolean", "description": "results_of_checking_marked_positions", "nullable": true }, "federal_tax_service_url": { "maxLength": 256, "type": "string", "description": "federal_tax_service_url", "nullable": true }, "operational_receipt_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FTOperatingReceiptAttribute" }, "description": "operational_receipt_attributes", "nullable": true }, "additional_receipt_attribute": { "maxLength": 16, "type": "string", "description": "additional_receipt_attribute", "nullable": true }, "additional_user_attribute": { "$ref": "#/components/schemas/FTAdditionalAttribute" }, "industry_receipt_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FTIndustryAttribute" }, "description": "industry_receipt_attributes", "nullable": true }, "qr_code": { "type": "string", "description": "qr_code", "nullable": true }, "print_view": { "maxLength": 32768, "type": "string", "description": "print_view", "nullable": true }, "vat_receipt_total": { "type": "array", "items": { "$ref": "#/components/schemas/FEVatReceiptItem" }, "description": "vat_receipt_total", "nullable": true }, "is_internet_payment": { "type": "boolean", "description": "is_internet_payment", "nullable": true }, "fiscal_document_format": { "$ref": "#/components/schemas/FEFiscalFormats" }, "organization_name": { "maxLength": 256, "type": "string", "description": "organization_name", "nullable": true }, "organization_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "organization_inn", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar_registration_number": { "maxLength": 20, "minLength": 0, "type": "string", "description": "fiscal_registrar_registration_number", "nullable": true }, "fiscal_registrar_serial_number": { "type": "string", "description": "fiscal_registrar_serial_number", "nullable": true }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "cashier_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "cashier_inn", "nullable": true }, "settlement_address": { "maxLength": 256, "type": "string", "description": "settlement_address", "nullable": true }, "settlement_location": { "maxLength": 256, "type": "string", "description": "settlement_location", "nullable": true }, "fiscal_document_number": { "type": "integer", "description": "fiscal_document_number", "format": "int32" }, "fiscal_drive_number": { "maxLength": 16, "minLength": 0, "type": "string", "description": "fiscal_drive_number", "nullable": true }, "fiscal_sign": { "type": "integer", "description": "fiscal_sign", "format": "int64", "nullable": true }, "additional_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FCAdditionalAttribute" }, "description": "additional_attributes", "nullable": true }, "print_mode": { "$ref": "#/components/schemas/FDPrintMode" }, "ofd_url": { "type": "string", "description": "ofd_url", "nullable": true }, "external_id": { "type": "string", "description": "external_id", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FDStrictFormOfCorrection": { "type": "object", "properties": { "fiscal_document_name": { "type": "string", "description": "fiscal_document_name", "nullable": true, "readOnly": true }, "fiscal_document_form": { "$ref": "#/components/schemas/FEFiscalForms" }, "correction_type": { "$ref": "#/components/schemas/FECorrectionTypes" }, "basis_for_correction": { "$ref": "#/components/schemas/FTCorrectionBasis" }, "customer_data": { "$ref": "#/components/schemas/FTCustomerData" }, "receipt_number": { "type": "integer", "description": "receipt_number", "format": "int32" }, "shift_number": { "type": "integer", "description": "shift_number", "format": "int32" }, "operation_type": { "$ref": "#/components/schemas/FEOperationTypes" }, "tax_system": { "$ref": "#/components/schemas/TaxSystems" }, "machine_number": { "maxLength": 20, "type": "string", "description": "machine_number", "nullable": true }, "customer_contacts": { "maxLength": 64, "type": "string", "description": "customer_contacts", "nullable": true }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/FTReceiptPosition" }, "description": "positions", "nullable": true }, "total_sum": { "type": "integer", "description": "total_sum", "format": "int64", "nullable": true }, "sum_by_cash": { "type": "integer", "description": "sum_by_cash", "format": "int64" }, "sum_by_card": { "type": "integer", "description": "sum_by_card", "format": "int64" }, "sum_by_prepayment": { "type": "integer", "description": "sum_by_prepayment", "format": "int64" }, "sum_by_postpayment": { "type": "integer", "description": "sum_by_postpayment", "format": "int64" }, "sum_by_considerations": { "type": "integer", "description": "sum_by_considerations", "format": "int64" }, "sum_of_vat_1102": { "type": "integer", "description": "sum_of_vat_1102", "format": "int64", "nullable": true }, "sum_of_vat_1103": { "type": "integer", "description": "sum_of_vat_1103", "format": "int64", "nullable": true }, "sum_of_vat_1104": { "type": "integer", "description": "sum_of_vat_1104", "format": "int64", "nullable": true }, "sum_of_vat_1105": { "type": "integer", "description": "sum_of_vat_1105", "format": "int64", "nullable": true }, "sum_of_vat_1106": { "type": "integer", "description": "sum_of_vat_1106", "format": "int64", "nullable": true }, "sum_of_vat_1107": { "type": "integer", "description": "sum_of_vat_1107", "format": "int64", "nullable": true }, "used_for_internet_only": { "type": "boolean", "description": "used_for_internet_only", "nullable": true }, "receipt_sender_email": { "maxLength": 64, "type": "string", "description": "receipt_sender_email", "nullable": true }, "results_of_checking_marked_positions": { "type": "boolean", "description": "results_of_checking_marked_positions", "nullable": true }, "federal_tax_service_url": { "maxLength": 256, "type": "string", "description": "federal_tax_service_url", "nullable": true }, "operational_receipt_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FTOperatingReceiptAttribute" }, "description": "operational_receipt_attributes", "nullable": true }, "additional_receipt_attribute": { "maxLength": 16, "type": "string", "description": "additional_receipt_attribute", "nullable": true }, "additional_user_attribute": { "$ref": "#/components/schemas/FTAdditionalAttribute" }, "industry_receipt_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FTIndustryAttribute" }, "description": "industry_receipt_attributes", "nullable": true }, "qr_code": { "type": "string", "description": "qr_code", "nullable": true }, "print_view": { "maxLength": 32768, "type": "string", "description": "print_view", "nullable": true }, "vat_receipt_total": { "type": "array", "items": { "$ref": "#/components/schemas/FEVatReceiptItem" }, "description": "vat_receipt_total", "nullable": true }, "is_internet_payment": { "type": "boolean", "description": "is_internet_payment", "nullable": true }, "fiscal_document_format": { "$ref": "#/components/schemas/FEFiscalFormats" }, "organization_name": { "maxLength": 256, "type": "string", "description": "organization_name", "nullable": true }, "organization_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "organization_inn", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar_registration_number": { "maxLength": 20, "minLength": 0, "type": "string", "description": "fiscal_registrar_registration_number", "nullable": true }, "fiscal_registrar_serial_number": { "type": "string", "description": "fiscal_registrar_serial_number", "nullable": true }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "cashier_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "cashier_inn", "nullable": true }, "settlement_address": { "maxLength": 256, "type": "string", "description": "settlement_address", "nullable": true }, "settlement_location": { "maxLength": 256, "type": "string", "description": "settlement_location", "nullable": true }, "fiscal_document_number": { "type": "integer", "description": "fiscal_document_number", "format": "int32" }, "fiscal_drive_number": { "maxLength": 16, "minLength": 0, "type": "string", "description": "fiscal_drive_number", "nullable": true }, "fiscal_sign": { "type": "integer", "description": "fiscal_sign", "format": "int64", "nullable": true }, "additional_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FCAdditionalAttribute" }, "description": "additional_attributes", "nullable": true }, "print_mode": { "$ref": "#/components/schemas/FDPrintMode" }, "ofd_url": { "type": "string", "description": "ofd_url", "nullable": true }, "external_id": { "type": "string", "description": "external_id", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FEAgentTypes": { "enum": [ "BankPayingAgent", "BankPayingSubagent", "PayingAgent", "PayingSubagent", "Attorney", "Consignee", "Agent" ], "type": "string" }, "FECorrectionTypes": { "enum": [ "SelfDriven", "OnDemand" ], "type": "string" }, "FEFOIV": { "enum": [ "InternalAffairsMinistry", "EmergencySituationsMinistry", "ForeignAffairsMinistry", "CommonwealthOfIndependentStatesFA", "DefenseMinistry", "MilitaryTechnicalCooperationFS", "TechnicalAndExportControlFS", "JusticeMinistry", "PenitentiaryFS", "BailiffsFS", "StateCourierFS", "IntelligenceFS", "FederalSecurityFS", "NationalGuardFS", "ProtectiveFS", "FinancialMonitoringFS", "ArchivalFA", "SpecialPresidentProgramsDirectorate", "PresidentDirectorate", "HealthMinistry", "HealthcareSurveillanceFS", "CultureMinistry", "ScienceandHigherEducationMinistry", "NaturalResourcesAndEnvironmentMinistry", "HydrometeorologyAndEnvironmentalMonitoringFS", "NaturalResourcesSurveillanceFS", "WaterResourcesFA", "ForestryFA", "MineralResourcesFA", "IndustryAndTradeMinistry", "TechnicalRegulationAndMetrologyFA", "EducationMinistry", "DevelopmentOfFarEastAndArcticMinistry", "AgricultureMinistry", "VeterinaryAndPhytosanitarySupervisionFS", "FisheryFa", "SportMinistry", "ConstructionHousingAndUtilitiesMinistry", "TransportMinistry", "SupervisionOfTransportFS", "AirTransportFA", "RoadFA", "RailTransportFA", "MaritimeAndRiverTransportFA", "LaborAndSocialProtectionMinistry", "LaborAndEmploymentFS", "FinanceMinistry", "TaxationFS", "AssayFS", "AlcoholMarketRegulationFS", "CustomsFS", "TreasuryFS", "StatePropertyManagementFA", "DigitalDevelopmentCommunicationsAndMassMediaMinistry", "SupervisionOfCommunicationsItAndMassMediaFS", "PressAndMassMediaFA", "CommunicationFA", "EconomicDevelopmentMinistry", "AccreditationFS", "StateStatisticsFS", "IntellectualPropertyFS", "TourismFA", "EnergyMinistry", "AntimonopolyFS", "StateRegistrationCadastreAndCartographyFS", "ConsumerRightsProtectionAndHumanWellbeingFS", "SupervisionInEducationAndScienceFS", "EnvironmentalTechnologicalAndNuclearSupervisionFS", "StateReservesFA", "MedicalBiologicalFA", "YouthFA", "EthnicaffairsFA" ], "type": "string" }, "FEFiscalFormats": { "enum": [ "Version1", "Version2", "Version3", "Version4" ], "type": "string" }, "FEFiscalForms": { "enum": [ "RegistrationReport", "ShiftOpeningReport", "Receipt", "StrictForm", "ShiftClosingReport", "FiscalDriveClosingReport", "OperatorConfirmation", "ReRegistrationReport", "SettlementReport", "ReceiptOfCorrection", "StrictFormOfCorrection" ], "type": "string" }, "FEFiscalRegistrarUsingConditions": { "enum": [ "UsedByMachine", "UsedForStrictForms", "UsedForInternetOnly", "UsedForExcisableGoods", "UsedForMarkedPositions", "UsedForServiceClearing", "UsedForGambling", "UsedForLotteries", "UsedForPawnshops", "UsedForInsurance" ], "type": "string" }, "FEGoodDataCheckingResult": { "enum": [ "KMChecked", "KPKMCorrect", "OISMStatusChecked", "OISMStatusCorrect", "KPKMCheckedAutonomously" ], "type": "string" }, "FEIdentityDocumentTypeCodes": { "enum": [ "RFPassport", "RFSpecialPassport", "RFTemporaryIdentity", "RFBirthCertificate", "RFOtherDocuments", "ForeignPassport", "ForeignOtherDocuments", "ForeignIdentity", "ForeignResidence", "ForeignTemporaryResidence", "RefugeeApplication", "RefugeeIdentity", "RefugeeOtherDocuments", "ForeignTemporaryIdentity" ], "type": "string" }, "FEMeasuresOfQuantity": { "enum": [ "Piece", "Gram", "Kilogram", "Ton", "Centimeter", "Decimeter", "Meter", "SquareCentimeter", "SquareDecimeter", "SquareMeter", "Milliliter", "Liter", "CubicMeter", "KilowattHour", "Gigacalorie", "Day", "Hour", "Minute", "Second", "Kilobyte", "Megabyte", "Gigabyte", "Terabyte", "Other" ], "type": "string" }, "FEOfdMessages": { "enum": [ "FormatLogicErrorWasDetected", "MessagesCheckingIsRequired", "FiscalRegistrarFormatUpdatingIsRequired", "YourProblemsWerePlanned", "SettingsChangingIsRequired", "OfdIsRevoked" ], "type": "string" }, "FEOperationTypes": { "enum": [ "Inflow", "InflowRefund", "Outflow", "OutflowRefund" ], "type": "string" }, "FEReRegistrationReasons": { "enum": [ "FiscalDriveChanging", "OfdChanging", "OrganizationNameChanging", "AddressChanging", "AutonomousModeTurningOff", "AutonomousModeTurningOn", "FiscalRegistrarVersionChanging", "TaxSystemsChanging", "MachineNumberChanging", "AutomaticModeTurningOff", "AutomaticModeTurningOn", "StrictFormsModeTurningOn", "StrictFormsModeTurningOff", "InternetOnlyModeTurningOff", "InternetOnlyModeTurningOn", "AgentModeTurningOff", "AgentModeTurningOn", "GamblingModeTurningOff", "GamblingModeTurningOn", "LotteryModeTurningOff", "LotteryModeTurningOn", "FfdVersionChanging", "Other" ], "type": "string" }, "FESettlementMethods": { "enum": [ "Prepayment", "PartialPrepayment", "AdvancePayment", "FullPayment", "PartialPaymentAndCredit", "Credit", "CreditPayment" ], "type": "string" }, "FESettlementSubjectTypes": { "enum": [ "Product", "ExcisableProduct", "Work", "Service", "GamblingBet", "GamblingWin", "LotteryBet", "LotteryWin", "IntellectualProperty", "Payment", "AgentCommission", "Payout", "Other", "PropertyRights", "NonRealizationIncome", "OtherPayments", "TradeFee", "ResortFee", "Bail", "Outflow", "ContributionForOPSIP", "ContributionForOPS", "ContributionForOMSIP", "ContributionForOMS", "ContributionForOOS", "CasinoPayment", "Cashout", "ATNM", "ATM", "TNM", "TM" ], "type": "string" }, "FESignsOfNotValidCodes": { "enum": [ "HasIncorrectCodeResponse", "HasIncorrectCodeNotification" ], "type": "string" }, "FESignsOfNotValidRequestsAndNotifications": { "enum": [ "NegativeResultOfProcessingCodeRequest", "NegativeResultOfProcessingNotificationRequest" ], "type": "string" }, "FEValueAddedTaxCodes": { "enum": [ "Vat1102", "Vat1103", "Vat1104", "Vat1105", "Vat1106", "Vat1107", "Vat5", "Vat105", "Vat7", "Vat107", "Vat22", "Vat122" ], "type": "string" }, "FEVatReceiptItem": { "type": "object", "properties": { "vat_rate_1199": { "$ref": "#/components/schemas/FEValueAddedTaxCodes" }, "sum_of_vat_1120": { "type": "integer", "description": "sum_of_vat_1120", "format": "int64" } }, "additionalProperties": false }, "FTAdditionalAttribute": { "type": "object", "properties": { "additional_attribute_name": { "maxLength": 64, "type": "string", "description": "additional_attribute_name", "nullable": true }, "additional_attribute_value": { "maxLength": 256, "type": "string", "description": "additional_attribute_value", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FTAgentData": { "type": "object", "properties": { "transfer_operator_name": { "maxLength": 64, "type": "string", "description": "transfer_operator_name", "nullable": true }, "transfer_operator_phones": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "transfer_operator_phones", "nullable": true }, "transfer_operator_address": { "maxLength": 256, "type": "string", "description": "transfer_operator_address", "nullable": true }, "transfer_operator_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "transfer_operator_inn", "nullable": true }, "paying_agent_operation": { "maxLength": 24, "type": "string", "description": "paying_agent_operation", "nullable": true }, "paying_agent_phones": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "paying_agent_phones", "nullable": true }, "payment_operator_phones": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "payment_operator_phones", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FTCorrectionBasis": { "type": "object", "properties": { "date": { "type": "string", "description": "date", "format": "date-time", "nullable": true }, "tax_service_doc_number": { "maxLength": 32, "type": "string", "description": "tax_service_doc_number", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FTCorrectionCounters": { "type": "object", "properties": { "total_count": { "type": "integer", "description": "total_count", "format": "int32", "nullable": true }, "inflow_counters": { "$ref": "#/components/schemas/FTOperationCounters" }, "outflow_counters": { "$ref": "#/components/schemas/FTOperationCounters" }, "inflow_refund_counters": { "$ref": "#/components/schemas/FTOperationCounters" }, "outflow_refund_counters": { "$ref": "#/components/schemas/FTOperationCounters" }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FTCustomerData": { "type": "object", "properties": { "customer_name": { "maxLength": 256, "type": "string", "description": "customer_name", "nullable": true }, "customer_inn": { "maxLength": 12, "minLength": 0, "type": "string", "description": "customer_inn", "nullable": true }, "customer_date_of_birth": { "type": "string", "description": "customer_date_of_birth", "format": "date-time", "nullable": true }, "citizenship": { "$ref": "#/components/schemas/CountryCodes" }, "identity_document_type_code": { "$ref": "#/components/schemas/FEIdentityDocumentTypeCodes" }, "identity_document_data": { "maxLength": 64, "type": "string", "description": "identity_document_data", "nullable": true }, "customer_address": { "maxLength": 256, "type": "string", "description": "customer_address", "nullable": true } }, "additionalProperties": false }, "FTFractionalCountOfMarkedPosition": { "type": "object", "properties": { "numerator": { "type": "integer", "description": "numerator", "format": "int64" }, "denominator": { "type": "integer", "description": "denominator", "format": "int64" } }, "additionalProperties": false }, "FTGoodCodes": { "type": "object", "properties": { "unknown": { "maxLength": 32, "type": "string", "description": "unknown", "nullable": true }, "ean8": { "maxLength": 8, "minLength": 0, "type": "string", "description": "ean8", "nullable": true }, "ean13": { "maxLength": 13, "minLength": 0, "type": "string", "description": "ean13", "nullable": true }, "itf14": { "maxLength": 14, "minLength": 0, "type": "string", "description": "itf14", "nullable": true }, "gs1": { "maxLength": 38, "type": "string", "description": "gs1", "nullable": true }, "gs1m": { "maxLength": 38, "type": "string", "description": "gs1m", "nullable": true }, "kmk": { "maxLength": 38, "type": "string", "description": "kmk", "nullable": true }, "mi": { "maxLength": 20, "minLength": 0, "type": "string", "description": "mi", "nullable": true }, "egais2": { "maxLength": 33, "minLength": 0, "type": "string", "description": "egais2", "nullable": true }, "egais3": { "maxLength": 14, "minLength": 0, "type": "string", "description": "egais3", "nullable": true }, "f1": { "maxLength": 32, "type": "string", "description": "f1", "nullable": true }, "f2": { "maxLength": 32, "type": "string", "description": "f2", "nullable": true }, "f3": { "maxLength": 32, "type": "string", "description": "f3", "nullable": true }, "f4": { "maxLength": 32, "type": "string", "description": "f4", "nullable": true }, "f5": { "maxLength": 32, "type": "string", "description": "f5", "nullable": true }, "f6": { "maxLength": 32, "type": "string", "description": "f6", "nullable": true } }, "additionalProperties": false }, "FTIndustryAttribute": { "type": "object", "properties": { "foiv": { "$ref": "#/components/schemas/FEFOIV" }, "basis_document_date": { "type": "string", "description": "basis_document_date", "format": "date-time", "nullable": true }, "basis_document_number": { "maxLength": 32, "type": "string", "description": "basis_document_number", "nullable": true }, "attribute_value": { "maxLength": 256, "type": "string", "description": "attribute_value", "nullable": true } }, "additionalProperties": false }, "FTOperatingReceiptAttribute": { "type": "object", "properties": { "operation_date": { "type": "string", "description": "operation_date", "format": "date-time", "nullable": true }, "operation_id": { "type": "integer", "description": "operation_id", "format": "int32", "nullable": true }, "operation_data": { "maxLength": 64, "type": "string", "description": "operation_data", "nullable": true } }, "additionalProperties": false }, "FTOperationCounters": { "type": "object", "properties": { "total_sum_by_cash": { "type": "integer", "description": "total_sum_by_cash", "format": "int64", "nullable": true }, "total_sum_by_card": { "type": "integer", "description": "total_sum_by_card", "format": "int64", "nullable": true }, "total_sum_by_prepayments": { "type": "integer", "description": "total_sum_by_prepayments", "format": "int64", "nullable": true }, "total_sum_by_postpayments": { "type": "integer", "description": "total_sum_by_postpayments", "format": "int64", "nullable": true }, "total_sum_by_considerations": { "type": "integer", "description": "total_sum_by_considerations", "format": "int64", "nullable": true }, "total_sum": { "type": "integer", "description": "total_sum", "format": "int64", "nullable": true }, "total_count": { "type": "integer", "description": "total_count", "format": "int32", "nullable": true }, "sum_of_vat_1102": { "type": "integer", "description": "sum_of_vat_1102", "format": "int64", "nullable": true }, "sum_of_vat_1103": { "type": "integer", "description": "sum_of_vat_1103", "format": "int64", "nullable": true }, "sum_of_vat_1106": { "type": "integer", "description": "sum_of_vat_1106", "format": "int64", "nullable": true }, "sum_of_vat_1107": { "type": "integer", "description": "sum_of_vat_1107", "format": "int64", "nullable": true }, "sum_of_vat_1104": { "type": "integer", "description": "sum_of_vat_1104", "format": "int64", "nullable": true }, "sum_of_vat_1105": { "type": "integer", "description": "sum_of_vat_1105", "format": "int64", "nullable": true } }, "additionalProperties": false }, "FTReceiptPosition": { "required": [ "method", "subject" ], "type": "object", "properties": { "method": { "$ref": "#/components/schemas/FESettlementMethods" }, "subject": { "$ref": "#/components/schemas/FESettlementSubjectTypes" }, "code": { "type": "string", "description": "code", "format": "byte", "nullable": true, "deprecated": true }, "as_agent_type_of": { "$ref": "#/components/schemas/FEAgentTypes" }, "agent_data": { "$ref": "#/components/schemas/FTAgentData" }, "supplier_data": { "$ref": "#/components/schemas/FTSupplierData" }, "supplier_inn": { "maxLength": 12, "minLength": 10, "type": "string", "description": "supplier_inn", "nullable": true }, "name": { "maxLength": 128, "type": "string", "description": "name", "nullable": true }, "country": { "$ref": "#/components/schemas/CountryCodes" }, "declaration_number": { "maxLength": 32, "type": "string", "description": "declaration_number", "nullable": true }, "price_per_unit": { "type": "integer", "description": "price_per_unit", "format": "int64" }, "vat_per_unit": { "type": "integer", "description": "vat_per_unit", "format": "int64", "nullable": true }, "quantity": { "type": "number", "description": "quantity", "format": "double" }, "excise_fee": { "type": "integer", "description": "excise_fee", "format": "int64", "nullable": true }, "vat_rate": { "$ref": "#/components/schemas/FEValueAddedTaxCodes" }, "total_vat": { "type": "integer", "description": "total_vat", "format": "int64", "nullable": true }, "total_price": { "type": "integer", "description": "total_price", "format": "int64", "nullable": true }, "additional_attribute": { "maxLength": 64, "type": "string", "description": "additional_attribute", "nullable": true }, "measure_of_quantity": { "$ref": "#/components/schemas/FEMeasuresOfQuantity" }, "good_code": { "$ref": "#/components/schemas/FTGoodCodes" }, "control_code": { "maxLength": 4, "type": "string", "description": "control_code", "nullable": true }, "code_processing_mode": { "type": "boolean", "description": "code_processing_mode", "nullable": true }, "good_data_checking_result": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FEGoodDataCheckingResult" }, "description": "good_data_checking_result", "nullable": true }, "fractional_count_of_marked_position": { "$ref": "#/components/schemas/FTFractionalCountOfMarkedPosition" }, "industry_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/FTIndustryAttribute" }, "description": "industry_attributes", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FTSupplierData": { "type": "object", "properties": { "supplier_phones": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "supplier_phones", "nullable": true }, "supplier_name": { "maxLength": 256, "type": "string", "description": "supplier_name", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FTTotalCounters": { "type": "object", "properties": { "total_count": { "type": "integer", "description": "total_count", "format": "int32", "nullable": true }, "inflow_counters": { "$ref": "#/components/schemas/FTOperationCounters" }, "inflow_refund_counters": { "$ref": "#/components/schemas/FTOperationCounters" }, "outflow_counters": { "$ref": "#/components/schemas/FTOperationCounters" }, "outflow_refund_counters": { "$ref": "#/components/schemas/FTOperationCounters" }, "correction_counters": { "$ref": "#/components/schemas/FTCorrectionCounters" }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "FiscalDataFormats": { "enum": [ "Version1", "Version2", "Version3", "Version4" ], "type": "string" }, "FiscalDocOrderings": { "enum": [ "created_at_asc", "created_at_desc", "updated_at_asc", "updated_at_desc", "fiscal_form_asc", "fiscal_form_desc", "number_asc", "number_desc", "issued_at_asc", "issued_at_desc" ], "type": "string" }, "FiscalDocumentFiscalDriveClosingReport": { "required": [ "fiscal_drive_number", "fiscal_form", "issued_at", "number", "sources" ], "type": "object", "properties": { "fiscal_form": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "fiscal_drive_number": { "maxLength": 16, "minLength": 16, "pattern": "^\\d+$", "type": "string", "description": "fiscal_drive_number" }, "number": { "type": "integer", "description": "number", "format": "int32" }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar": { "$ref": "#/components/schemas/FiscalRegistrarReference" }, "sources": { "$ref": "#/components/schemas/FDFiscalDriveClosingReport" }, "source_type": { "$ref": "#/components/schemas/SourceType" }, "fiscal_status": { "$ref": "#/components/schemas/FiscalStatus" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "FiscalDocumentForms": { "enum": [ "RegistrationReport", "ShiftOpeningReport", "Receipt", "StrictForm", "ShiftClosingReport", "FiscalDriveClosingReport", "OperatorConfirmation", "ReRegistrationReport", "SettlementReport", "ReceiptOfCorrection", "StrictFormOfCorrection" ], "type": "string" }, "FiscalDocumentOperatorConfirmation": { "required": [ "fiscal_drive_number", "fiscal_form", "issued_at", "number", "sources" ], "type": "object", "properties": { "fiscal_form": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "fiscal_drive_number": { "maxLength": 16, "minLength": 16, "pattern": "^\\d+$", "type": "string", "description": "fiscal_drive_number" }, "number": { "type": "integer", "description": "number", "format": "int32" }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar": { "$ref": "#/components/schemas/FiscalRegistrarReference" }, "sources": { "$ref": "#/components/schemas/FDOperatorConfirmation" }, "source_type": { "$ref": "#/components/schemas/SourceType" }, "fiscal_status": { "$ref": "#/components/schemas/FiscalStatus" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "FiscalDocumentReRegistrationReport": { "required": [ "fiscal_drive_number", "fiscal_form", "issued_at", "number", "sources" ], "type": "object", "properties": { "fiscal_form": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "fiscal_drive_number": { "maxLength": 16, "minLength": 16, "pattern": "^\\d+$", "type": "string", "description": "fiscal_drive_number" }, "number": { "type": "integer", "description": "number", "format": "int32" }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar": { "$ref": "#/components/schemas/FiscalRegistrarReference" }, "sources": { "$ref": "#/components/schemas/FDReRegistrationReport" }, "source_type": { "$ref": "#/components/schemas/SourceType" }, "fiscal_status": { "$ref": "#/components/schemas/FiscalStatus" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "FiscalDocumentReceipt": { "required": [ "fiscal_drive_number", "fiscal_form", "issued_at", "number", "sources" ], "type": "object", "properties": { "fiscal_form": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "fiscal_drive_number": { "maxLength": 16, "minLength": 16, "pattern": "^\\d+$", "type": "string", "description": "fiscal_drive_number" }, "number": { "type": "integer", "description": "number", "format": "int32" }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar": { "$ref": "#/components/schemas/FiscalRegistrarReference" }, "sources": { "$ref": "#/components/schemas/FDReceipt" }, "source_type": { "$ref": "#/components/schemas/SourceType" }, "fiscal_status": { "$ref": "#/components/schemas/FiscalStatus" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "FiscalDocumentReceiptOfCorrection": { "required": [ "fiscal_drive_number", "fiscal_form", "issued_at", "number", "sources" ], "type": "object", "properties": { "fiscal_form": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "fiscal_drive_number": { "maxLength": 16, "minLength": 16, "pattern": "^\\d+$", "type": "string", "description": "fiscal_drive_number" }, "number": { "type": "integer", "description": "number", "format": "int32" }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar": { "$ref": "#/components/schemas/FiscalRegistrarReference" }, "sources": { "$ref": "#/components/schemas/FDReceiptOfCorrection" }, "source_type": { "$ref": "#/components/schemas/SourceType" }, "fiscal_status": { "$ref": "#/components/schemas/FiscalStatus" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "FiscalDocumentRegistrationReport": { "required": [ "fiscal_drive_number", "fiscal_form", "issued_at", "number", "sources" ], "type": "object", "properties": { "fiscal_form": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "fiscal_drive_number": { "maxLength": 16, "minLength": 16, "pattern": "^\\d+$", "type": "string", "description": "fiscal_drive_number" }, "number": { "type": "integer", "description": "number", "format": "int32" }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar": { "$ref": "#/components/schemas/FiscalRegistrarReference" }, "sources": { "$ref": "#/components/schemas/FDRegistrationReport" }, "source_type": { "$ref": "#/components/schemas/SourceType" }, "fiscal_status": { "$ref": "#/components/schemas/FiscalStatus" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "FiscalDocumentSettlementReport": { "required": [ "fiscal_drive_number", "fiscal_form", "issued_at", "number", "sources" ], "type": "object", "properties": { "fiscal_form": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "fiscal_drive_number": { "maxLength": 16, "minLength": 16, "pattern": "^\\d+$", "type": "string", "description": "fiscal_drive_number" }, "number": { "type": "integer", "description": "number", "format": "int32" }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar": { "$ref": "#/components/schemas/FiscalRegistrarReference" }, "sources": { "$ref": "#/components/schemas/FDSettlementReport" }, "source_type": { "$ref": "#/components/schemas/SourceType" }, "fiscal_status": { "$ref": "#/components/schemas/FiscalStatus" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "FiscalDocumentShiftClosingReport": { "required": [ "fiscal_drive_number", "fiscal_form", "issued_at", "number", "sources" ], "type": "object", "properties": { "fiscal_form": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "fiscal_drive_number": { "maxLength": 16, "minLength": 16, "pattern": "^\\d+$", "type": "string", "description": "fiscal_drive_number" }, "number": { "type": "integer", "description": "number", "format": "int32" }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar": { "$ref": "#/components/schemas/FiscalRegistrarReference" }, "sources": { "$ref": "#/components/schemas/FDShiftClosingReport" }, "source_type": { "$ref": "#/components/schemas/SourceType" }, "fiscal_status": { "$ref": "#/components/schemas/FiscalStatus" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "FiscalDocumentShiftOpeningReport": { "required": [ "fiscal_drive_number", "fiscal_form", "issued_at", "number", "sources" ], "type": "object", "properties": { "fiscal_form": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "fiscal_drive_number": { "maxLength": 16, "minLength": 16, "pattern": "^\\d+$", "type": "string", "description": "fiscal_drive_number" }, "number": { "type": "integer", "description": "number", "format": "int32" }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar": { "$ref": "#/components/schemas/FiscalRegistrarReference" }, "sources": { "$ref": "#/components/schemas/FDShiftOpeningReport" }, "source_type": { "$ref": "#/components/schemas/SourceType" }, "fiscal_status": { "$ref": "#/components/schemas/FiscalStatus" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "FiscalDocumentStrictForm": { "required": [ "fiscal_drive_number", "fiscal_form", "issued_at", "number", "sources" ], "type": "object", "properties": { "fiscal_form": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "fiscal_drive_number": { "maxLength": 16, "minLength": 16, "pattern": "^\\d+$", "type": "string", "description": "fiscal_drive_number" }, "number": { "type": "integer", "description": "number", "format": "int32" }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar": { "$ref": "#/components/schemas/FiscalRegistrarReference" }, "sources": { "$ref": "#/components/schemas/FDStrictForm" }, "source_type": { "$ref": "#/components/schemas/SourceType" }, "fiscal_status": { "$ref": "#/components/schemas/FiscalStatus" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "FiscalDocumentStrictFormOfCorrection": { "required": [ "fiscal_drive_number", "fiscal_form", "issued_at", "number", "sources" ], "type": "object", "properties": { "fiscal_form": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "fiscal_drive_number": { "maxLength": 16, "minLength": 16, "pattern": "^\\d+$", "type": "string", "description": "fiscal_drive_number" }, "number": { "type": "integer", "description": "number", "format": "int32" }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_registrar": { "$ref": "#/components/schemas/FiscalRegistrarReference" }, "sources": { "$ref": "#/components/schemas/FDStrictFormOfCorrection" }, "source_type": { "$ref": "#/components/schemas/SourceType" }, "fiscal_status": { "$ref": "#/components/schemas/FiscalStatus" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "FiscalPaymentTypes": { "enum": [ "Cash", "Card", "PrePayment", "PostPayment", "Considerations" ], "type": "string" }, "FiscalRegistrar": { "required": [ "fiscal_data_format", "fiscal_drive_number", "model", "registration_number", "serial_number" ], "type": "object", "properties": { "model": { "maxLength": 32, "minLength": 1, "type": "string", "description": "model" }, "version": { "maxLength": 32, "type": "string", "description": "version", "nullable": true }, "serial_number": { "maxLength": 20, "minLength": 1, "pattern": "^\\d+$", "type": "string", "description": "serial_number" }, "registration_number": { "maxLength": 20, "minLength": 1, "pattern": "^\\d+$", "type": "string", "description": "registration_number" }, "fiscal_drive_number": { "maxLength": 16, "minLength": 16, "pattern": "^\\d+$", "type": "string", "description": "fiscal_drive_number" }, "fiscal_data_format": { "$ref": "#/components/schemas/FiscalDataFormats" }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "fiscal_drive_expired_at": { "type": "string", "description": "fiscal_drive_expired_at", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "FiscalRegistrarOrderings": { "enum": [ "created_at_asc", "created_at_desc", "updated_at_asc", "updated_at_desc", "model_asc", "model_desc", "serial_number_asc", "serial_number_desc", "registration_number_asc", "registration_number_desc" ], "type": "string" }, "FiscalRegistrarPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FiscalRegistrar" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "FiscalRegistrarReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "FiscalStatus": { "enum": [ "Queued", "InProgress", "WaitingForRetry", "Printed", "Cancelled", "Fail" ], "type": "string" }, "GenerateActivationCodeParams": { "required": [ "employee" ], "type": "object", "properties": { "employee": { "$ref": "#/components/schemas/EmployeeReference" }, "send_sms": { "type": "boolean", "description": "send_sms" }, "outlet": { "$ref": "#/components/schemas/OutletReference" } }, "additionalProperties": false }, "GeneratedActivationCode": { "type": "object", "properties": { "activation_code": { "type": "string", "description": "activation_code", "nullable": true } }, "additionalProperties": false }, "Good": { "required": [ "name", "settlement_subject", "tax", "uom" ], "type": "object", "properties": { "settlement_subject": { "$ref": "#/components/schemas/SettlementSubjects" }, "name": { "maxLength": 128, "minLength": 1, "type": "string", "description": "name" }, "uom": { "$ref": "#/components/schemas/UomReference" }, "default_price": { "$ref": "#/components/schemas/Money" }, "tax": { "$ref": "#/components/schemas/ValueAddedTaxRates" }, "description": { "maxLength": 256, "type": "string", "description": "description", "nullable": true }, "made_in": { "$ref": "#/components/schemas/CountryCodes" }, "barcodes": { "maxLength": 128, "type": "string", "description": "barcodes (__*Required__ when `is_markable=true`)", "format": "[EAN-8|EAN-13|ITF-14]", "nullable": true }, "barcodes_local": { "maxLength": 128, "type": "string", "description": "barcodes_local", "nullable": true }, "category": { "$ref": "#/components/schemas/GoodsCategoryReference" }, "is_serial": { "type": "boolean", "description": "is_serial", "default": false, "nullable": true }, "is_markable": { "type": "boolean", "description": "is_markable", "default": false, "nullable": true }, "is_part_of_package_of": { "maximum": 99999999, "minimum": 2, "type": "integer", "description": "is_part_of_package_of", "format": "int32", "nullable": true }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "is_egais_markable": { "type": "boolean", "description": "is_egais_markable", "default": false, "nullable": true }, "external_number": { "maxLength": 36, "minLength": 1, "type": "string", "description": "external_number", "nullable": true }, "is_patent": { "type": "boolean", "description": "is_patent", "default": false, "nullable": true }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "GoodImportPreviewItem": { "type": "object", "properties": { "before": { "$ref": "#/components/schemas/Good" }, "after": { "$ref": "#/components/schemas/Good" } }, "additionalProperties": false }, "GoodImportPreviewItemPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GoodImportPreviewItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "GoodOrderings": { "enum": [ "created_at_asc", "created_at_desc", "updated_at_asc", "updated_at_desc", "name_asc", "name_desc" ], "type": "string" }, "GoodPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Good" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "GoodsCategory": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 128, "minLength": 1, "type": "string", "description": "name" }, "description": { "maxLength": 64, "type": "string", "description": "description", "nullable": true }, "parent_category": { "$ref": "#/components/schemas/GoodsCategoryReference" }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "GoodsCategoryImportPreviewItem": { "type": "object", "properties": { "before": { "$ref": "#/components/schemas/GoodsCategory" }, "after": { "$ref": "#/components/schemas/GoodsCategory" } }, "additionalProperties": false }, "GoodsCategoryImportPreviewItemPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GoodsCategoryImportPreviewItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "GoodsCategoryOrderings": { "enum": [ "created_at_asc", "created_at_desc", "updated_at_asc", "updated_at_desc", "name_asc", "name_desc" ], "type": "string" }, "GoodsCategoryPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GoodsCategory" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "GoodsCategoryReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "GrowthRate": { "type": "object", "properties": { "percentage": { "type": "integer", "description": "percentage", "format": "int32" }, "is_calculated": { "type": "boolean", "description": "is_calculated" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "IAsyncTask": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AsyncTaskStatuses" }, "progress": { "type": "integer", "description": "progress", "format": "int32", "readOnly": true }, "resolutions": { "type": "array", "items": { "$ref": "#/components/schemas/Resolution" }, "description": "resolutions", "nullable": true } }, "additionalProperties": false }, "IAsyncTaskPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/IAsyncTask" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "IExtensionObject": { "type": "object", "additionalProperties": false }, "IFiscalDocument": { "required": [ "fiscal_drive_number", "fiscal_form", "issued_at", "number" ], "type": "object", "properties": { "fiscal_form": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "fiscal_drive_number": { "maxLength": 16, "minLength": 0, "pattern": "^\\d+$", "type": "string", "description": "fiscal_drive_number" }, "number": { "type": "integer", "description": "number", "format": "int32" }, "cashier_name": { "maxLength": 64, "type": "string", "description": "cashier_name", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "source_type": { "$ref": "#/components/schemas/SourceType" }, "fiscal_status": { "$ref": "#/components/schemas/FiscalStatus" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "IFiscalDocumentPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/IFiscalDocument" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "IFiscalDocumentReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "INomenclatureImportParams": { "type": "object", "properties": { "import_strategy": { "$ref": "#/components/schemas/NomenclatureImportStrategies" }, "attributes_for_matching": { "$ref": "#/components/schemas/NomenclatureImportMatchingAttributes" } }, "additionalProperties": false }, "IPaymentPart": { "required": [ "amount", "status" ], "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/Money" }, "status": { "$ref": "#/components/schemas/PaymentPartStatuses" }, "primary_payment_part": { "$ref": "#/components/schemas/IPaymentPartReference" }, "primary_sale_session": { "$ref": "#/components/schemas/ISaleSessionReference" }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "IPaymentPartReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ISaleSession": { "type": "object", "properties": { "sale": { "$ref": "#/components/schemas/SaleReference" }, "actions": { "$ref": "#/components/schemas/SaleActions" }, "fiscal_documents": { "type": "array", "items": { "$ref": "#/components/schemas/IFiscalDocumentReference" }, "description": "fiscal_documents", "nullable": true }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ISaleSessionPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ISaleSession" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ISaleSessionReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ITerminalBase": { "type": "object", "properties": { "model": { "type": "string", "description": "model", "nullable": true }, "terminal_id": { "type": "string", "description": "terminal_id", "nullable": true }, "merchant_id": { "type": "string", "description": "merchant_id", "nullable": true }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "online_type": { "$ref": "#/components/schemas/PTOnlineType" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ITerminalBasePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ITerminalBase" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ITerminalBaseReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ITransactionBase": { "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/Money" }, "registered_at": { "type": "string", "description": "registered_at", "format": "date-time" }, "operation": { "$ref": "#/components/schemas/TransactionOperationTypes" }, "transaction_type": { "$ref": "#/components/schemas/PTTransactionType" }, "status": { "$ref": "#/components/schemas/PTTransactionStatus" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ITransactionBasePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ITransactionBase" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ITransactionBaseReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "IdentityDocumentTypes": { "enum": [ "RFPassport", "RFSpecialPassport", "RFTemporaryIdentity", "RFBirthCertificate", "RFOtherDocuments", "ForeignPassport", "ForeignOtherDocuments", "ForeignIdentity", "ForeignResidence", "ForeignTemporaryResidence", "RefugeeApplication", "RefugeeIdentity", "RefugeeOtherDocuments", "ForeignTemporaryIdentity" ], "type": "string" }, "ImportColumnMapping": { "type": "object", "properties": { "first_data_row": { "type": "integer", "description": "first_data_row", "format": "int32" }, "uom_name_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "uom_name_column", "nullable": true }, "uom_symbol_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "uom_symbol_column", "nullable": true }, "uom_is_fractional_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "uom_is_fractional_column", "nullable": true }, "uom_ru_okei_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "uom_ru_okei_column", "nullable": true }, "uom_unece_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "uom_unece_column", "nullable": true }, "good_name_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "good_name_column", "nullable": true }, "good_tax_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "good_tax_column", "nullable": true }, "settlement_subject_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "settlement_subject_column", "nullable": true }, "good_default_price_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "good_default_price_column", "nullable": true }, "good_description_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "good_description_column", "nullable": true }, "good_made_in_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "good_made_in_column", "nullable": true }, "good_barcodes_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "good_barcodes_column", "nullable": true }, "good_barcodes_local_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "good_barcodes_local_column", "nullable": true }, "good_is_serial_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "good_is_serial_column", "nullable": true }, "good_is_markable_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "good_is_markable_column", "nullable": true }, "good_is_part_of_package_of": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "good_is_part_of_package_of", "nullable": true }, "goods_category_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "goods_category_column", "nullable": true }, "good_is_patent_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "good_is_patent_column", "nullable": true }, "is_default": { "type": "boolean", "description": "is_default", "readOnly": true } }, "additionalProperties": false }, "Invoice": { "type": "object", "properties": { "company": { "$ref": "#/components/schemas/Company" }, "number": { "type": "string", "description": "number", "nullable": true }, "total_sum": { "$ref": "#/components/schemas/Money" }, "status": { "$ref": "#/components/schemas/InvoiceStatuses" }, "payment_by_card_link": { "type": "string", "description": "payment_by_card_link", "nullable": true }, "payment_by_transaction_link": { "type": "string", "description": "payment_by_transaction_link", "nullable": true }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicePosition" }, "description": "positions", "nullable": true }, "is_created_from_lifepos": { "type": "boolean", "description": "is_created_from_lifepos" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "InvoicePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "InvoicePosition": { "type": "object", "properties": { "name": { "type": "string", "description": "name", "nullable": true }, "quantity": { "type": "integer", "description": "quantity", "format": "int32" }, "price": { "$ref": "#/components/schemas/Money" }, "total_sum": { "$ref": "#/components/schemas/Money" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "InvoiceStatuses": { "enum": [ "Unknown", "Pending", "Paid", "Canceled", "Refunded" ], "type": "string" }, "LegalEntity": { "required": [ "inn", "juridical_address", "juridical_name", "tax_systems" ], "type": "object", "properties": { "juridical_name": { "maxLength": 256, "minLength": 2, "type": "string", "description": "juridical_name" }, "juridical_address": { "maxLength": 256, "minLength": 2, "type": "string", "description": "juridical_address" }, "inn": { "minLength": 1, "type": "string", "description": "inn" }, "tax_systems": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TaxSystems" }, "description": "tax_systems" }, "kpp": { "maxLength": 9, "minLength": 9, "pattern": "^\\d+$", "type": "string", "description": "kpp", "nullable": true }, "ogrn": { "type": "string", "description": "ogrn", "nullable": true }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "crpt_token": { "type": "string", "description": "crpt_token", "nullable": true }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "LegalEntityOrderings": { "enum": [ "created_at_asc", "created_at_desc", "updated_at_asc", "updated_at_desc", "juridical_name_asc", "juridical_name_desc" ], "type": "string" }, "LegalEntityPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LegalEntity" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "LegalEntityReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "LifePayCloudFiscalRegistrar": { "required": [ "api_key", "environment", "id" ], "type": "object", "properties": { "id": { "maxLength": 32, "minLength": 1, "type": "string", "description": "id" }, "friendly_name": { "maxLength": 32, "type": "string", "description": "friendly_name", "nullable": true }, "environment": { "$ref": "#/components/schemas/LifePayCloudFiscalizationEnvironments" }, "api_key": { "maxLength": 32, "minLength": 32, "type": "string", "description": "api_key" }, "target_kkt_group_uuid": { "type": "string", "description": "target_kkt_group_uuid", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "LifePayCloudFiscalizationEnvironments": { "enum": [ "production", "test" ], "type": "string" }, "LifePayQuickPaymentsEnvironments": { "enum": [ "production", "test" ], "type": "string" }, "LifePayQuickPaymentsTerminalSettings": { "required": [ "api_key", "environment", "id" ], "type": "object", "properties": { "id": { "maxLength": 32, "minLength": 1, "type": "string", "description": "id" }, "environment": { "$ref": "#/components/schemas/LifePayQuickPaymentsEnvironments" }, "api_key": { "maxLength": 32, "minLength": 32, "type": "string", "description": "api_key" }, "friendly_name": { "maxLength": 32, "type": "string", "description": "friendly_name", "nullable": true } }, "additionalProperties": false }, "LifepaySmartPosTmsParams": { "required": [ "ca1", "ca2", "ip", "port" ], "type": "object", "properties": { "ip": { "maxLength": 64, "minLength": 1, "type": "string", "description": "ip" }, "port": { "maximum": 99999, "minimum": 0, "type": "integer", "description": "port", "format": "int32" }, "ca1": { "maxLength": 4096, "minLength": 1, "type": "string", "description": "ca1" }, "ca2": { "maxLength": 4096, "minLength": 1, "type": "string", "description": "ca2" }, "ident_guid": { "type": "string", "description": "ident_guid", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "LinkPaymentPart": { "required": [ "amount", "status" ], "type": "object", "properties": { "external_id": { "maxLength": 64, "minLength": 1, "type": "string", "description": "external_id", "nullable": true }, "ttl": { "maximum": 2880, "minimum": 5, "type": "integer", "description": "ttl", "format": "int32", "nullable": true }, "payment_url": { "maxLength": 256, "minLength": 0, "type": "string", "description": "payment_url", "nullable": true }, "expired_at": { "type": "string", "description": "expired_at", "format": "date-time", "nullable": true }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/ITransactionBaseReference" }, "description": "transactions", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "amount": { "$ref": "#/components/schemas/Money" }, "status": { "$ref": "#/components/schemas/PaymentPartStatuses" }, "primary_payment_part": { "$ref": "#/components/schemas/IPaymentPartReference" }, "primary_sale_session": { "$ref": "#/components/schemas/ISaleSessionReference" }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "Mark": { "required": [ "for_quantity" ], "type": "object", "properties": { "marking_code": { "maxLength": 256, "type": "string", "description": "marking_code", "nullable": true }, "checking_result": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FEGoodDataCheckingResult" }, "description": "checking_result", "nullable": true }, "for_quantity": { "type": "number", "description": "for_quantity", "format": "double" }, "full_sold": { "type": "boolean", "description": "full_sold", "nullable": true } }, "additionalProperties": false }, "MarkingAttributes": { "required": [ "marks" ], "type": "object", "properties": { "is_part_of_package_of": { "maximum": 99999999, "minimum": 2, "type": "integer", "description": "is_part_of_package_of", "format": "int32", "nullable": true }, "marks": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Mark" }, "description": "marks" } }, "additionalProperties": false }, "Me": { "required": [ "name", "permissions", "phone", "role", "username" ], "type": "object", "properties": { "name": { "maxLength": 64, "minLength": 5, "type": "string", "description": "name" }, "role": { "$ref": "#/components/schemas/RoleReference" }, "phone": { "maxLength": 18, "minLength": 10, "pattern": "((8|\\+7)-?)?\\(?\\d{3,5}\\)?-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}((-?\\d{1})?-?\\d{1})?", "type": "string", "description": "phone" }, "username": { "maxLength": 24, "minLength": 2, "type": "string", "description": "username" }, "inn": { "maxLength": 12, "minLength": 12, "pattern": "^\\d+$", "type": "string", "description": "inn", "nullable": true }, "pin_code_hash": { "maxLength": 32, "minLength": 32, "type": "string", "description": "pin_code_hash", "nullable": true }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAccessGroup" }, "description": "permissions" }, "email": { "maxLength": 64, "minLength": 6, "type": "string", "description": "email", "format": "email", "nullable": true }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "MobileSyncOrganizationExtension": { "required": [ "version" ], "type": "object", "properties": { "days_back": { "maximum": 45, "minimum": 1, "type": "integer", "description": "days_back", "format": "int32", "nullable": true }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "Money": { "required": [ "currency" ], "type": "object", "properties": { "value": { "type": "integer", "description": "value", "format": "int64" }, "currency": { "$ref": "#/components/schemas/CurrencyCodes" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "MoneyAction": { "type": "object", "properties": { "purposes": { "type": "array", "items": { "$ref": "#/components/schemas/MoneyActionPurpose" }, "description": "purposes", "nullable": true }, "payment_parts": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/BNPLPaymentPart" }, { "$ref": "#/components/schemas/CardPaymentPart" }, { "$ref": "#/components/schemas/CashPaymentPart" }, { "$ref": "#/components/schemas/CashlessPaymentPart" }, { "$ref": "#/components/schemas/LinkPaymentPart" }, { "$ref": "#/components/schemas/QuickPaymentPaymentPart" } ] }, "description": "payment_parts", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "modified_at": { "type": "string", "description": "modified_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "MoneyActionPurpose": { "required": [ "amount" ], "type": "object", "properties": { "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "amount": { "$ref": "#/components/schemas/Money" }, "position": { "$ref": "#/components/schemas/DealPositionReference" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "MoneyPurposesReportForGoodsWidget": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MoneyPurposesReportForGoodsWidgetItem" }, "description": "items" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "MoneyPurposesReportForGoodsWidgetItem": { "required": [ "current_quantity", "current_summary", "good_name", "growth_rate", "previous_quantity", "previous_summary", "uom" ], "type": "object", "properties": { "uom": { "$ref": "#/components/schemas/UomReference" }, "good_name": { "minLength": 1, "type": "string", "description": "good_name" }, "current_summary": { "$ref": "#/components/schemas/RevenueSummary" }, "previous_summary": { "$ref": "#/components/schemas/RevenueSummary" }, "growth_rate": { "$ref": "#/components/schemas/GrowthRate" }, "current_quantity": { "type": "number", "description": "current_quantity", "format": "double" }, "previous_quantity": { "type": "number", "description": "previous_quantity", "format": "double" } }, "additionalProperties": false }, "NadexSoftPOSWorkplaceExtension": { "required": [ "version", "virtual_serial_number" ], "type": "object", "properties": { "turned_on": { "type": "boolean", "description": "turned_on" }, "virtual_serial_number": { "maxLength": 19, "minLength": 19, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "description": "virtual_serial_number" }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "NomenclatureAttributesForExport": { "type": "object", "properties": { "include_uom_name_column": { "type": "boolean", "description": "include_uom_name_column" }, "include_uom_symbol_column": { "type": "boolean", "description": "include_uom_symbol_column" }, "include_uom_is_fractional_column": { "type": "boolean", "description": "include_uom_is_fractional_column" }, "include_uom_ru_okei_column": { "type": "boolean", "description": "include_uom_ru_okei_column" }, "include_uom_unece_column": { "type": "boolean", "description": "include_uom_unece_column" }, "include_good_name_column": { "type": "boolean", "description": "include_good_name_column" }, "include_good_tax_column": { "type": "boolean", "description": "include_good_tax_column" }, "include_good_settlement_subject_column": { "type": "boolean", "description": "include_good_settlement_subject_column" }, "include_good_default_price_column": { "type": "boolean", "description": "include_good_default_price_column" }, "include_good_description_column": { "type": "boolean", "description": "include_good_description_column" }, "include_good_made_in_column": { "type": "boolean", "description": "include_good_made_in_column" }, "include_good_barcodes_column": { "type": "boolean", "description": "include_good_barcodes_column" }, "include_good_barcodes_local_column": { "type": "boolean", "description": "include_good_barcodes_local_column" }, "include_good_is_serial_column": { "type": "boolean", "description": "include_good_is_serial_column" }, "include_good_is_markable_column": { "type": "boolean", "description": "include_good_is_markable_column" }, "include_good_is_archived_column": { "type": "boolean", "description": "include_good_is_archived_column" }, "include_good_is_part_of_column": { "type": "boolean", "description": "include_good_is_part_of_column" }, "include_goods_category_column": { "type": "boolean", "description": "include_goods_category_column" }, "include_good_is_patent_column": { "type": "boolean", "description": "include_good_is_patent_column" } }, "additionalProperties": false }, "NomenclatureExportParams": { "type": "object", "properties": { "attributes_for_export": { "$ref": "#/components/schemas/NomenclatureAttributesForExport" }, "selection_parameters": { "$ref": "#/components/schemas/SelectionModes" } }, "additionalProperties": false }, "NomenclatureExportTask": { "type": "object", "properties": { "mime_type": { "type": "string", "description": "mime_type", "nullable": true, "readOnly": true }, "parameters": { "$ref": "#/components/schemas/NomenclatureExportParams" }, "status": { "$ref": "#/components/schemas/AsyncTaskStatuses" }, "progress": { "type": "integer", "description": "progress", "format": "int32" }, "resolutions": { "type": "array", "items": { "$ref": "#/components/schemas/Resolution" }, "description": "resolutions", "nullable": true }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "NomenclatureExportTaskPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NomenclatureExportTask" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "NomenclatureImportFromExcelParams": { "required": [ "import_strategy" ], "type": "object", "properties": { "import_strategy": { "$ref": "#/components/schemas/NomenclatureImportStrategies" }, "attributes_for_matching": { "$ref": "#/components/schemas/NomenclatureImportMatchingAttributes" }, "column_mapping": { "$ref": "#/components/schemas/ImportColumnMapping" } }, "additionalProperties": false }, "NomenclatureImportMatchingAttributes": { "type": "object", "properties": { "use_good_name": { "type": "boolean", "description": "use_good_name" }, "use_barcodes": { "type": "boolean", "description": "use_barcodes" }, "use_barcodes_local": { "type": "boolean", "description": "use_barcodes_local" } }, "additionalProperties": false }, "NomenclatureImportStrategies": { "enum": [ "FullImport", "IncrementalImport" ], "type": "string" }, "NomenclatureImportTask": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/INomenclatureImportParams" }, "file": { "type": "string", "description": "file", "format": "uuid" }, "is_confirmed": { "type": "boolean", "description": "is_confirmed" }, "status": { "$ref": "#/components/schemas/AsyncTaskStatuses" }, "progress": { "type": "integer", "description": "progress", "format": "int32" }, "resolutions": { "type": "array", "items": { "$ref": "#/components/schemas/Resolution" }, "description": "resolutions", "nullable": true }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "NomenclatureImportTaskPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NomenclatureImportTask" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "NonPurposeMoneyAction": { "required": [ "amount" ], "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/Money" }, "payment_parts": { "type": "array", "items": { "$ref": "#/components/schemas/IPaymentPart" }, "description": "payment_parts", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "modified_at": { "type": "string", "description": "modified_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "NotificationServiceOrganizationExtension": { "required": [ "primary_url_for_notifications", "turned_on", "version" ], "type": "object", "properties": { "turned_on": { "type": "boolean", "description": "turned_on" }, "primary_url_for_notifications": { "minLength": 1, "type": "string", "description": "primary_url_for_notifications", "format": "uri" }, "secondary_url_for_notifications": { "type": "string", "description": "secondary_url_for_notifications", "format": "uri", "nullable": true }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "Operation": { "type": "object", "properties": { "value": { "description": "value", "nullable": true }, "path": { "type": "string", "description": "path", "nullable": true }, "op": { "type": "string", "description": "op", "nullable": true }, "from": { "type": "string", "description": "from", "nullable": true } }, "additionalProperties": false }, "OperationReportAttributesForExport": { "type": "object", "additionalProperties": false }, "OperationReportExportParams": { "type": "object", "properties": { "attributes_for_export": { "$ref": "#/components/schemas/OperationReportAttributesForExport" }, "filters_for_export": { "$ref": "#/components/schemas/OperationReportFiltersForExport" } }, "additionalProperties": false }, "OperationReportExportTask": { "required": [ "report_export_type" ], "type": "object", "properties": { "mime_type": { "type": "string", "description": "mime_type", "nullable": true, "readOnly": true }, "report_export_type": { "$ref": "#/components/schemas/ReportExportType" }, "parameters": { "$ref": "#/components/schemas/OperationReportExportParams" }, "status": { "$ref": "#/components/schemas/AsyncTaskStatuses" }, "progress": { "type": "integer", "description": "progress", "format": "int32" }, "resolutions": { "type": "array", "items": { "$ref": "#/components/schemas/Resolution" }, "description": "resolutions", "nullable": true }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "OperationReportExportTaskPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OperationReportExportTask" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "OperationReportFiltersForExport": { "type": "object", "properties": { "date_from": { "type": "string", "description": "date_from", "format": "date-time", "nullable": true }, "date_to": { "type": "string", "description": "date_to", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Option": { "type": "object", "properties": { "key": { "type": "string", "description": "key", "nullable": true }, "value": { "type": "string", "description": "value", "nullable": true }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "OptionPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Option" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "Organization": { "required": [ "alias", "name" ], "type": "object", "properties": { "name": { "maxLength": 24, "minLength": 2, "type": "string", "description": "name" }, "alias": { "maxLength": 24, "minLength": 2, "pattern": "^[a-zA-Z0-9_-]{2,24}$", "type": "string", "description": "alias" }, "owner": { "$ref": "#/components/schemas/EmployeeReference" }, "support": { "$ref": "#/components/schemas/TechSupportContacts" }, "extensions": { "title": "OrganizationExtensions", "properties": { "notification_service": { "$ref": "#/components/schemas/NotificationServiceOrganizationExtension" }, "auth": { "$ref": "#/components/schemas/AuthOrganizationExtension" }, "pos_warehouse": { "$ref": "#/components/schemas/PosWarehouseOrganizationExtension" }, "unified_personal_account": { "$ref": "#/components/schemas/UnifiedPersonalAccountExtension" }, "mobile_sync": { "$ref": "#/components/schemas/MobileSyncOrganizationExtension" } }, "description": "Расширения" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "OrganizationAliasAvailability": { "required": [ "alias" ], "type": "object", "properties": { "alias": { "maxLength": 24, "minLength": 2, "pattern": "^[a-zA-Z0-9_-]{2,24}$", "type": "string", "description": "alias" } }, "additionalProperties": false }, "OrganizationExtensions": { "title": "OrganizationExtensions", "properties": { "notification_service": { "$ref": "#/components/schemas/NotificationServiceOrganizationExtension" }, "auth": { "$ref": "#/components/schemas/AuthOrganizationExtension" }, "pos_warehouse": { "$ref": "#/components/schemas/PosWarehouseOrganizationExtension" }, "unified_personal_account": { "$ref": "#/components/schemas/UnifiedPersonalAccountExtension" }, "mobile_sync": { "$ref": "#/components/schemas/MobileSyncOrganizationExtension" } }, "description": "Расширения" }, "OrganizationOrderings": { "enum": [ "created_at_asc", "created_at_desc", "updated_at_asc", "updated_at_desc", "name_asc", "name_desc" ], "type": "string" }, "OrganizationPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "OrganizationReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "Outlet": { "required": [ "address", "legal_entity", "name" ], "type": "object", "properties": { "name": { "maxLength": 256, "minLength": 2, "type": "string", "description": "name" }, "address": { "maxLength": 256, "minLength": 2, "type": "string", "description": "address" }, "legal_entity": { "$ref": "#/components/schemas/LegalEntityReference" }, "brand": { "$ref": "#/components/schemas/BrandReference" }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "extensions": { "title": "OutletExtensions", "properties": { "retail_app": { "$ref": "#/components/schemas/RetailAppOutletExtension" }, "cloud_fiscalization": { "$ref": "#/components/schemas/CloudFiscalizationExtension" }, "external_discount_calculator": { "$ref": "#/components/schemas/ExternalDiscountCalculatorOutletExtension" }, "pay_quick_payments": { "$ref": "#/components/schemas/PayQuickPaymentsOutletExtension" }, "payment_methods": { "$ref": "#/components/schemas/PaymentMethodsOutletExtension" }, "ckt_soft_pos": { "$ref": "#/components/schemas/CktSoftPOSOutletExtension" }, "discounts": { "$ref": "#/components/schemas/DiscountsOutletExtension" }, "bnpl_podeli": { "$ref": "#/components/schemas/PodeliOutletExtension" }, "pos_quick_payments": { "$ref": "#/components/schemas/PosQuickPaymentsOutletExtensions" }, "receipt_customization": { "$ref": "#/components/schemas/ReceiptCustomizationOutletExtension" } }, "description": "Расширения" }, "online_type": { "$ref": "#/components/schemas/PTOnlineType" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "OutletExtensions": { "title": "OutletExtensions", "properties": { "retail_app": { "$ref": "#/components/schemas/RetailAppOutletExtension" }, "cloud_fiscalization": { "$ref": "#/components/schemas/CloudFiscalizationExtension" }, "external_discount_calculator": { "$ref": "#/components/schemas/ExternalDiscountCalculatorOutletExtension" }, "pay_quick_payments": { "$ref": "#/components/schemas/PayQuickPaymentsOutletExtension" }, "payment_methods": { "$ref": "#/components/schemas/PaymentMethodsOutletExtension" }, "ckt_soft_pos": { "$ref": "#/components/schemas/CktSoftPOSOutletExtension" }, "discounts": { "$ref": "#/components/schemas/DiscountsOutletExtension" }, "bnpl_podeli": { "$ref": "#/components/schemas/PodeliOutletExtension" }, "pos_quick_payments": { "$ref": "#/components/schemas/PosQuickPaymentsOutletExtensions" }, "receipt_customization": { "$ref": "#/components/schemas/ReceiptCustomizationOutletExtension" } }, "description": "Расширения" }, "OutletOrderings": { "enum": [ "created_at_asc", "created_at_desc", "updated_at_asc", "updated_at_desc", "name_asc", "name_desc" ], "type": "string" }, "OutletPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Outlet" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "OutletReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "PTAdditionalAttribute": { "type": "object", "properties": { "name": { "maxLength": 128, "type": "string", "description": "name", "nullable": true }, "value": { "type": "string", "description": "value", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "PTEOperations": { "enum": [ "Payment", "Cancellation", "Refund", "Rollback" ], "type": "string" }, "PTOnlineType": { "enum": [ "Offline", "Online" ], "type": "string" }, "PTPaymentType": { "enum": [ "Card", "YaPay", "MirPay", "SberPay" ], "type": "string" }, "PTTransaction": { "required": [ "currency_code", "operation" ], "type": "object", "properties": { "operation": { "$ref": "#/components/schemas/PTEOperations" }, "merchant_id": { "maxLength": 24, "type": "string", "description": "merchant_id", "nullable": true }, "terminal_id": { "maxLength": 24, "type": "string", "description": "terminal_id", "nullable": true }, "number": { "type": "integer", "description": "number", "format": "int32" }, "amount": { "type": "integer", "description": "amount", "format": "int32" }, "currency_code": { "$ref": "#/components/schemas/CurrencyCodes" }, "registered_at": { "type": "string", "description": "registered_at", "format": "date-time" }, "authorization_code": { "maxLength": 16, "type": "string", "description": "authorization_code", "nullable": true }, "reference_retrieval_number": { "maxLength": 24, "type": "string", "description": "reference_retrieval_number", "nullable": true }, "emv_application_identifier": { "maxLength": 24, "type": "string", "description": "emv_application_identifier", "nullable": true }, "emv_application_label": { "maxLength": 48, "type": "string", "description": "emv_application_label", "nullable": true }, "card_number": { "maxLength": 19, "type": "string", "description": "card_number", "nullable": true }, "cardholder_name": { "maxLength": 32, "type": "string", "description": "cardholder_name", "nullable": true }, "card_expires_at": { "type": "string", "description": "card_expires_at", "format": "date-time", "nullable": true }, "card_hash": { "maxLength": 256, "type": "string", "description": "card_hash", "nullable": true }, "host_response_code": { "maxLength": 8, "type": "string", "description": "host_response_code", "nullable": true }, "host_response_message": { "maxLength": 128, "type": "string", "description": "host_response_message", "nullable": true }, "print_view": { "type": "string", "description": "print_view", "nullable": true }, "additional_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/PTAdditionalAttribute" }, "description": "additional_attributes", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true } }, "additionalProperties": false }, "PTTransactionStatus": { "enum": [ "Completed", "Hold", "Rejected" ], "type": "string" }, "PTTransactionType": { "enum": [ "Offline", "Online" ], "type": "string" }, "PayQuickPaymentsDynamicExtensions": { "required": [ "version" ], "type": "object", "properties": { "turned_on": { "type": "boolean", "description": "turned_on" }, "quick_payments_terminal_guid": { "type": "string", "description": "quick_payments_terminal_guid", "format": "uuid", "nullable": true }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "PayQuickPaymentsOutletExtension": { "required": [ "available_quick_payments_terminal_settings", "turned_on", "version" ], "type": "object", "properties": { "available_quick_payments_terminal_settings": { "type": "array", "items": { "$ref": "#/components/schemas/LifePayQuickPaymentsTerminalSettings" }, "description": "available_quick_payments_terminal_settings" }, "turned_on": { "type": "boolean", "description": "turned_on" }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "PaymentMethodsAvailability": { "required": [ "role" ], "type": "object", "properties": { "role": { "$ref": "#/components/schemas/RoleReference" }, "cash_payments_available": { "type": "boolean", "description": "cash_payments_available" }, "cashless_payments_available": { "type": "boolean", "description": "cashless_payments_available" }, "card_payments_available": { "type": "boolean", "description": "card_payments_available" }, "split_payments_available": { "type": "boolean", "description": "split_payments_available" }, "quick_payments_available": { "type": "boolean", "description": "quick_payments_available" }, "bnpl_payments_available": { "type": "boolean", "description": "bnpl_payments_available" }, "split_payments_available_methods": { "$ref": "#/components/schemas/SplitPaymentsAvailableMethods" } }, "additionalProperties": false }, "PaymentMethodsOutletExtension": { "required": [ "version" ], "type": "object", "properties": { "availabilities": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodsAvailability" }, "description": "availabilities", "nullable": true }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "PaymentMethodsSaleExtension": { "required": [ "version" ], "type": "object", "properties": { "availabilities": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodsAvailability" }, "description": "availabilities", "nullable": true }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "PaymentPartStatuses": { "enum": [ "Draft", "Accepted", "Refunded" ], "type": "string" }, "PaymentRecipientsSaleExtension": { "required": [ "payment_recipient_inn", "version" ], "type": "object", "properties": { "payment_recipient_inn": { "minLength": 1, "type": "string", "description": "payment_recipient_inn" }, "agent_inn": { "type": "string", "description": "agent_inn", "nullable": true }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "PodeliDetails": { "required": [ "order_id" ], "type": "object", "properties": { "order_id": { "maxLength": 44, "minLength": 1, "type": "string", "description": "order_id" } }, "additionalProperties": false }, "PodeliOutletExtension": { "required": [ "login", "pass", "version" ], "type": "object", "properties": { "login": { "maxLength": 256, "minLength": 1, "type": "string", "description": "login" }, "pass": { "maxLength": 256, "minLength": 1, "type": "string", "description": "pass" }, "turned_on": { "type": "boolean", "description": "turned_on" }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "PosQuickPaymentsOutletExtensions": { "required": [ "quick_payments_terminal_guid", "turned_on", "version" ], "type": "object", "properties": { "quick_payments_terminal_guid": { "type": "string", "description": "quick_payments_terminal_guid", "format": "uuid" }, "turned_on": { "type": "boolean", "description": "turned_on" }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "PosQuickPaymentsTerminalExtensions": { "required": [ "company_guid", "merchant_guid", "terminal_guid", "version" ], "type": "object", "properties": { "company_guid": { "minLength": 1, "type": "string", "description": "company_guid" }, "merchant_guid": { "minLength": 1, "type": "string", "description": "merchant_guid" }, "terminal_guid": { "minLength": 1, "type": "string", "description": "terminal_guid" }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "PosQuickPaymentsWorkplaceExtensions": { "required": [ "qr_registrar_guid", "version" ], "type": "object", "properties": { "qr_registrar_guid": { "minLength": 1, "type": "string", "description": "qr_registrar_guid" }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "PosWarehouseOrganizationExtension": { "required": [ "turned_on", "version" ], "type": "object", "properties": { "turned_on": { "type": "boolean", "description": "turned_on" }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "PresentationModes": { "enum": [ "compact", "full" ], "type": "string" }, "QPEOperations": { "enum": [ "Payment", "Refund" ], "type": "string" }, "QPTransaction": { "required": [ "amount", "currency", "operation", "registered_at", "terminal_id", "transaction_id" ], "type": "object", "properties": { "operation": { "$ref": "#/components/schemas/QPEOperations" }, "terminal_id": { "maxLength": 24, "minLength": 1, "type": "string", "description": "terminal_id" }, "merchant_id": { "maxLength": 24, "type": "string", "description": "merchant_id", "nullable": true }, "transaction_id": { "maxLength": 48, "minLength": 1, "type": "string", "description": "transaction_id" }, "registered_at": { "type": "string", "description": "registered_at", "format": "date-time" }, "requested_at": { "type": "string", "description": "requested_at", "format": "date-time" }, "amount": { "type": "integer", "description": "amount", "format": "int32" }, "currency": { "$ref": "#/components/schemas/CurrencyCodes" } }, "additionalProperties": false }, "QPType": { "enum": [ "Qr", "Nfc" ], "type": "string" }, "QuickPaymentPaymentPart": { "required": [ "amount", "status" ], "type": "object", "properties": { "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/ITransactionBaseReference" }, "description": "transactions", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "amount": { "$ref": "#/components/schemas/Money" }, "status": { "$ref": "#/components/schemas/PaymentPartStatuses" }, "primary_payment_part": { "$ref": "#/components/schemas/IPaymentPartReference" }, "primary_sale_session": { "$ref": "#/components/schemas/ISaleSessionReference" }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "QuickPaymentsTerminal": { "required": [ "model", "terminal_id" ], "type": "object", "properties": { "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "extensions": { "title": "QuickPaymentsTerminalExtensions", "properties": { "pos_quick_payments": { "$ref": "#/components/schemas/PosQuickPaymentsTerminalExtensions" } }, "description": "Расширения" }, "model": { "maxLength": 24, "minLength": 1, "type": "string", "description": "model" }, "terminal_id": { "maxLength": 24, "minLength": 1, "type": "string", "description": "terminal_id" }, "merchant_id": { "maxLength": 24, "type": "string", "description": "merchant_id", "nullable": true }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "online_type": { "$ref": "#/components/schemas/PTOnlineType" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "QuickPaymentsTerminalExtensions": { "title": "QuickPaymentsTerminalExtensions", "properties": { "pos_quick_payments": { "$ref": "#/components/schemas/PosQuickPaymentsTerminalExtensions" } }, "description": "Расширения" }, "QuickPaymentsTerminalPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/QuickPaymentsTerminal" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "QuickPaymentsTransaction": { "required": [ "amount", "operation", "registered_at", "transaction_id" ], "type": "object", "properties": { "transaction_id": { "maxLength": 48, "minLength": 1, "type": "string", "description": "transaction_id" }, "requested_at": { "type": "string", "description": "requested_at", "format": "date-time", "nullable": true }, "sources": { "$ref": "#/components/schemas/QPTransaction" }, "quick_payments_terminal": { "$ref": "#/components/schemas/ITerminalBaseReference" }, "quick_payments_type": { "$ref": "#/components/schemas/QPType" }, "qp_transaction_id": { "type": "string", "description": "qp_transaction_id", "nullable": true }, "qp_bank_id": { "type": "string", "description": "qp_bank_id", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "amount": { "$ref": "#/components/schemas/Money" }, "registered_at": { "type": "string", "description": "registered_at", "format": "date-time" }, "operation": { "$ref": "#/components/schemas/TransactionOperationTypes" }, "transaction_type": { "$ref": "#/components/schemas/PTTransactionType" }, "status": { "$ref": "#/components/schemas/PTTransactionStatus" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "QuickPaymentsTransactionPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/QuickPaymentsTransaction" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ReceiptCustomizationOutletExtension": { "required": [ "version" ], "type": "object", "properties": { "customization_name": { "maxLength": 64, "minLength": 1, "type": "string", "description": "customization_name", "nullable": true }, "text": { "maxLength": 128, "minLength": 1, "type": "string", "description": "text", "nullable": true }, "area": { "$ref": "#/components/schemas/ReceiptCustomizationTextArea" }, "printable_header": { "type": "array", "items": { "type": "string" }, "description": "printable_header", "nullable": true, "readOnly": true }, "printable_footer": { "type": "array", "items": { "type": "string" }, "description": "printable_footer", "nullable": true, "readOnly": true }, "printable_qr": { "maxLength": 128, "type": "string", "description": "printable_qr", "format": "uri", "nullable": true }, "turned_on": { "type": "boolean", "description": "turned_on" }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "ReceiptCustomizationTextArea": { "enum": [ "Header", "Footer" ], "type": "string" }, "ReportCombinedAttributesForExport": { "type": "object", "properties": { "include_legal_entity_name": { "type": "boolean", "description": "include_legal_entity_name" }, "include_brand_name": { "type": "boolean", "description": "include_brand_name" }, "include_outlet_name": { "type": "boolean", "description": "include_outlet_name" }, "include_workplace_name": { "type": "boolean", "description": "include_workplace_name" }, "include_employee_name": { "type": "boolean", "description": "include_employee_name" }, "include_customer_name": { "type": "boolean", "description": "include_customer_name" }, "include_customer_contacts": { "type": "boolean", "description": "include_customer_contacts" }, "include_deal_comment": { "type": "boolean", "description": "include_deal_comment" }, "include_deal_number": { "type": "boolean", "description": "include_deal_number" }, "include_processed_at": { "type": "boolean", "description": "include_processed_at" }, "include_opened_at": { "type": "boolean", "description": "include_opened_at" }, "include_issued_at": { "type": "boolean", "description": "include_issued_at" }, "include_operation_status": { "type": "boolean", "description": "include_operation_status" }, "include_shipment_status": { "type": "boolean", "description": "include_shipment_status" }, "include_sale_status": { "type": "boolean", "description": "include_sale_status" }, "include_operation": { "type": "boolean", "description": "include_operation" }, "include_positions": { "type": "boolean", "description": "include_positions" }, "include_cash_part_amount": { "type": "boolean", "description": "include_cash_part_amount" }, "include_card_part_amount": { "type": "boolean", "description": "include_card_part_amount" }, "include_sbp_part_amount": { "type": "boolean", "description": "include_sbp_part_amount" }, "include_other_part_amount": { "type": "boolean", "description": "include_other_part_amount" }, "include_sum_by_prepayment": { "type": "boolean", "description": "include_sum_by_prepayment" }, "include_amount_otherwise": { "type": "boolean", "description": "include_amount_otherwise" }, "include_total_sum": { "type": "boolean", "description": "include_total_sum" }, "include_card_number": { "type": "boolean", "description": "include_card_number" }, "include_rrn": { "type": "boolean", "description": "include_rrn" }, "include_authorization_code": { "type": "boolean", "description": "include_authorization_code" }, "include_term_id": { "type": "boolean", "description": "include_term_id" }, "include_fiscalization_flag": { "type": "boolean", "description": "include_fiscalization_flag" }, "include_fiscal_form": { "type": "boolean", "description": "include_fiscal_form" }, "include_operation_type": { "type": "boolean", "description": "include_operation_type" }, "include_serial_number": { "type": "boolean", "description": "include_serial_number" }, "include_shift_number": { "type": "boolean", "description": "include_shift_number" }, "include_receipt_number": { "type": "boolean", "description": "include_receipt_number" }, "include_number": { "type": "boolean", "description": "include_number" }, "include_registration_number": { "type": "boolean", "description": "include_registration_number" }, "include_fiscal_drive_number": { "type": "boolean", "description": "include_fiscal_drive_number" }, "include_fiscal_sign": { "type": "boolean", "description": "include_fiscal_sign" }, "include_tax_system": { "type": "boolean", "description": "include_tax_system" }, "include_fiscal_document_format": { "type": "boolean", "description": "include_fiscal_document_format" }, "include_results_of_checking_marked_positions": { "type": "boolean", "description": "include_results_of_checking_marked_positions" } }, "additionalProperties": false }, "ReportCombinedExportParams": { "type": "object", "properties": { "attributes_for_export": { "$ref": "#/components/schemas/ReportCombinedAttributesForExport" }, "filters_for_export": { "$ref": "#/components/schemas/OperationReportFiltersForExport" } }, "additionalProperties": false }, "ReportCombinedItem": { "type": "object", "properties": { "legal_entity": { "$ref": "#/components/schemas/LegalEntityReference" }, "brand": { "$ref": "#/components/schemas/BrandReference" }, "outlet": { "$ref": "#/components/schemas/OutletReference" }, "workplace": { "$ref": "#/components/schemas/WorkplaceReference" }, "employee": { "$ref": "#/components/schemas/EmployeeReference" }, "customer_name": { "type": "string", "description": "customer_name", "nullable": true }, "customer_contacts": { "type": "string", "description": "customer_contacts", "nullable": true }, "deal_comment": { "type": "string", "description": "deal_comment", "nullable": true }, "deal_number": { "type": "string", "description": "deal_number", "nullable": true }, "processed_at": { "type": "string", "description": "processed_at", "format": "date-time", "nullable": true }, "opened_at": { "type": "string", "description": "opened_at", "format": "date-time", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time", "nullable": true }, "operation_status": { "type": "string", "description": "operation_status", "nullable": true }, "shipment_status": { "type": "string", "description": "shipment_status", "nullable": true }, "sale_status": { "type": "string", "description": "sale_status", "nullable": true }, "operation": { "$ref": "#/components/schemas/TransactionOperationTypes" }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/DealPosition" }, "description": "positions", "nullable": true }, "cash_part_amount": { "type": "integer", "description": "cash_part_amount", "format": "int64", "nullable": true }, "card_part_amount": { "type": "integer", "description": "card_part_amount", "format": "int64", "nullable": true }, "sbp_part_amount": { "type": "integer", "description": "sbp_part_amount", "format": "int64", "nullable": true }, "other_part_amount": { "type": "integer", "description": "other_part_amount", "format": "int64", "nullable": true }, "sum_by_prepayment": { "type": "integer", "description": "sum_by_prepayment", "format": "int64", "nullable": true }, "amount_otherwise": { "type": "integer", "description": "amount_otherwise", "format": "int64", "nullable": true }, "total_sum": { "type": "integer", "description": "total_sum", "format": "int64", "nullable": true }, "card_number": { "type": "string", "description": "card_number", "nullable": true }, "rrn": { "type": "string", "description": "rrn", "nullable": true }, "authorization_code": { "type": "string", "description": "authorization_code", "nullable": true }, "term_id": { "type": "string", "description": "term_id", "nullable": true }, "fiscalization_flag": { "type": "boolean", "description": "fiscalization_flag" }, "fiscal_form": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "operation_type": { "$ref": "#/components/schemas/FEOperationTypes" }, "serial_number": { "type": "string", "description": "serial_number", "nullable": true }, "shift_number": { "type": "integer", "description": "shift_number", "format": "int32", "nullable": true }, "receipt_number": { "type": "integer", "description": "receipt_number", "format": "int32", "nullable": true }, "number": { "type": "integer", "description": "number", "format": "int32", "nullable": true }, "registration_number": { "type": "string", "description": "registration_number", "nullable": true }, "fiscal_drive_number": { "type": "string", "description": "fiscal_drive_number", "nullable": true }, "fiscal_sign": { "type": "integer", "description": "fiscal_sign", "format": "int64", "nullable": true }, "tax_system": { "$ref": "#/components/schemas/TaxSystems" }, "fiscal_document_format": { "$ref": "#/components/schemas/FiscalDataFormats" }, "results_of_checking_marked_positions": { "type": "string", "description": "results_of_checking_marked_positions", "nullable": true }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ReportCombinedItemPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportCombinedItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ReportExportType": { "enum": [ "RevenueByPeriodsExcel", "RevenueByOutletsPeriodsExcel", "RevenueByEmploeesPeriodsExcel", "RevenueByPeriodsCSV", "RevenueByOutletsPeriodsCSV", "RevenueByEmploeesPeriodsCSV", "ReportTransactionExcel", "ReportTransactionCSV", "ReportFiscalDocumentExcel", "ReportFiscalDocumentCSV", "ReportMoneyOperationExcel", "ReportMoneyOperationCSV", "ReportPaymentAndRefundExcel", "ReportPaymentAndRefundCSV", "ReportCombinedExcel", "ReportCombinedCSV", "ReportNomenclatureResultExcel", "ReportNomenclatureResultCSV", "ReportNomenclatureBalancesResultExcel", "ReportNomenclatureBalancesResultCSV", "ReportNomenclatureProfitResultExcel", "ReportNomenclatureProfitResultCSV", "ReportNomenclatureStocksLimitsResultExcel", "ReportNomenclatureStocksLimitsResultCSV" ], "type": "string" }, "ReportFiscalAttributesForExport": { "type": "object", "properties": { "include_cashier_name": { "type": "boolean", "description": "include_cashier_name" }, "include_customer_contacts": { "type": "boolean", "description": "include_customer_contacts" }, "include_issued_at": { "type": "boolean", "description": "include_issued_at" }, "include_fiscal_form": { "type": "boolean", "description": "include_fiscal_form" }, "include_operation_type": { "type": "boolean", "description": "include_operation_type" }, "include_positions": { "type": "boolean", "description": "include_positions" }, "include_sum_by_prepayment": { "type": "boolean", "description": "include_sum_by_prepayment" }, "include_amount_otherwise": { "type": "boolean", "description": "include_amount_otherwise" }, "include_total_sum": { "type": "boolean", "description": "include_total_sum" }, "include_serial_number": { "type": "boolean", "description": "include_serial_number" }, "include_shift_number": { "type": "boolean", "description": "include_shift_number" }, "include_receipt_number": { "type": "boolean", "description": "include_receipt_number" }, "include_number": { "type": "boolean", "description": "include_number" }, "include_registration_number": { "type": "boolean", "description": "include_registration_number" }, "include_fiscal_drive_number": { "type": "boolean", "description": "include_fiscal_drive_number" }, "include_fiscal_sign": { "type": "boolean", "description": "include_fiscal_sign" }, "include_tax_system": { "type": "boolean", "description": "include_tax_system" }, "include_fiscal_document_format": { "type": "boolean", "description": "include_fiscal_document_format" }, "include_results_of_checking_marked_positions": { "type": "boolean", "description": "include_results_of_checking_marked_positions" } }, "additionalProperties": false }, "ReportFiscalDocumentItem": { "type": "object", "properties": { "cashier_name": { "type": "string", "description": "cashier_name", "nullable": true }, "customer_contacts": { "type": "string", "description": "customer_contacts", "nullable": true }, "issued_at": { "type": "string", "description": "issued_at", "format": "date-time" }, "fiscal_form": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "operation_type": { "$ref": "#/components/schemas/FEOperationTypes" }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/FTReceiptPosition" }, "description": "positions", "nullable": true }, "sum_by_prepayment": { "type": "integer", "description": "sum_by_prepayment", "format": "int64", "nullable": true }, "amount_otherwise": { "type": "integer", "description": "amount_otherwise", "format": "int64", "nullable": true }, "total_sum": { "type": "integer", "description": "total_sum", "format": "int64", "nullable": true }, "serial_number": { "type": "string", "description": "serial_number", "nullable": true }, "shift_number": { "type": "integer", "description": "shift_number", "format": "int32", "nullable": true }, "receipt_number": { "type": "integer", "description": "receipt_number", "format": "int32", "nullable": true }, "number": { "type": "integer", "description": "number", "format": "int32" }, "registration_number": { "type": "string", "description": "registration_number", "nullable": true }, "fiscal_drive_number": { "type": "string", "description": "fiscal_drive_number", "nullable": true }, "fiscal_sign": { "type": "integer", "description": "fiscal_sign", "format": "int64", "nullable": true }, "tax_system": { "$ref": "#/components/schemas/TaxSystems" }, "fiscal_document_format": { "$ref": "#/components/schemas/FiscalDataFormats" }, "results_of_checking_marked_positions": { "type": "string", "description": "results_of_checking_marked_positions", "nullable": true }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ReportFiscalDocumentItemPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportFiscalDocumentItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ReportFiscalExportParams": { "type": "object", "properties": { "attributes_for_export": { "$ref": "#/components/schemas/ReportFiscalAttributesForExport" }, "filters_for_export": { "$ref": "#/components/schemas/OperationReportFiltersForExport" } }, "additionalProperties": false }, "ReportMoneyAttributesForExport": { "type": "object", "properties": { "include_legal_entity_name": { "type": "boolean", "description": "include_legal_entity_name" }, "include_outlet_name": { "type": "boolean", "description": "include_outlet_name" }, "include_brand_name": { "type": "boolean", "description": "include_brand_name" }, "include_workplace_name": { "type": "boolean", "description": "include_workplace_name" }, "include_employee_name": { "type": "boolean", "description": "include_employee_name" }, "include_customer_name": { "type": "boolean", "description": "include_customer_name" }, "include_customer_contacts": { "type": "boolean", "description": "include_customer_contacts" }, "include_deal_number": { "type": "boolean", "description": "include_deal_number" }, "include_opened_at": { "type": "boolean", "description": "include_opened_at" }, "include_operation_status": { "type": "boolean", "description": "include_operation_status" }, "include_shipment_status": { "type": "boolean", "description": "include_shipment_status" }, "include_sale_status": { "type": "boolean", "description": "include_sale_status" }, "include_sale_action_type": { "type": "boolean", "description": "include_sale_action_type" }, "include_deal_comment": { "type": "boolean", "description": "include_deal_comment" }, "include_positions": { "type": "boolean", "description": "include_positions" }, "include_goods_amount": { "type": "boolean", "description": "include_goods_amount" }, "include_position_discount": { "type": "boolean", "description": "include_position_discount" } }, "additionalProperties": false }, "ReportMoneyExportParams": { "type": "object", "properties": { "attributes_for_export": { "$ref": "#/components/schemas/ReportMoneyAttributesForExport" }, "filters_for_export": { "$ref": "#/components/schemas/OperationReportFiltersForExport" } }, "additionalProperties": false }, "ReportMoneyItem": { "type": "object", "properties": { "legal_entity": { "$ref": "#/components/schemas/LegalEntityReference" }, "outlet": { "$ref": "#/components/schemas/OutletReference" }, "brand": { "$ref": "#/components/schemas/BrandReference" }, "workplace": { "$ref": "#/components/schemas/WorkplaceReference" }, "employee": { "$ref": "#/components/schemas/EmployeeReference" }, "customer_name": { "type": "string", "description": "customer_name", "nullable": true }, "customer_contacts": { "type": "string", "description": "customer_contacts", "nullable": true }, "deal_number": { "type": "string", "description": "deal_number", "nullable": true }, "sale_action_type": { "type": "string", "description": "sale_action_type", "nullable": true }, "opened_at": { "type": "string", "description": "opened_at", "format": "date-time", "nullable": true }, "operation_status": { "type": "string", "description": "operation_status", "nullable": true }, "shipment_status": { "type": "string", "description": "shipment_status", "nullable": true }, "sale_status": { "type": "string", "description": "sale_status", "nullable": true }, "deal_comment": { "type": "string", "description": "deal_comment", "nullable": true }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/DealPosition" }, "description": "positions", "nullable": true }, "goods_amount": { "type": "integer", "description": "goods_amount", "format": "int64", "nullable": true }, "position_discount": { "type": "integer", "description": "position_discount", "format": "int64", "nullable": true }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ReportMoneyItemPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportMoneyItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ReportNomenclatureBalanceResultItem": { "type": "object", "properties": { "category": { "type": "string", "description": "category", "nullable": true }, "name": { "type": "string", "description": "name", "nullable": true }, "quantity_payment": { "type": "number", "description": "quantity_payment", "format": "double" }, "quantity_refund": { "type": "number", "description": "quantity_refund", "format": "double" }, "revenue_amount": { "$ref": "#/components/schemas/Money" }, "refund_amount": { "$ref": "#/components/schemas/Money" }, "balance": { "type": "number", "description": "balance", "format": "double" }, "average_consumption": { "type": "number", "description": "average_consumption", "format": "double" }, "sale_days": { "type": "integer", "description": "sale_days", "format": "int32" } }, "additionalProperties": false }, "ReportNomenclatureBalanceResultItemPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportNomenclatureBalanceResultItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ReportNomenclatureBalanceType": { "enum": [ "FromValue", "ToValue", "Zero", "LessZero" ], "type": "string" }, "ReportNomenclatureBalancesResultAttributesForExport": { "type": "object", "properties": { "include_category": { "type": "boolean", "description": "include_category" }, "include_name": { "type": "boolean", "description": "include_name" }, "include_quantity_payment": { "type": "boolean", "description": "include_quantity_payment" }, "include_quantity_refund": { "type": "boolean", "description": "include_quantity_refund" }, "include_revenue_amount": { "type": "boolean", "description": "include_revenue_amount" }, "include_refund_amount": { "type": "boolean", "description": "include_refund_amount" }, "include_balance": { "type": "boolean", "description": "include_balance" }, "include_average_consumption": { "type": "boolean", "description": "include_average_consumption" }, "include_sale_days": { "type": "boolean", "description": "include_sale_days" } }, "additionalProperties": false }, "ReportNomenclatureBalancesResultExportParams": { "type": "object", "properties": { "attributes_for_export": { "$ref": "#/components/schemas/ReportNomenclatureBalancesResultAttributesForExport" }, "filters_for_export": { "$ref": "#/components/schemas/ReportNomenclatureBalancesResultFiltersForExport" } }, "additionalProperties": false }, "ReportNomenclatureBalancesResultFiltersForExport": { "type": "object", "properties": { "good_category_guid": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "good_category_guid", "nullable": true }, "outlet_guid": { "type": "string", "description": "outlet_guid", "format": "uuid" }, "warehouse_guid": { "type": "string", "description": "warehouse_guid", "format": "uuid", "nullable": true }, "balance_type": { "$ref": "#/components/schemas/BalanceType" }, "balance_value": { "type": "number", "description": "balance_value", "format": "double", "nullable": true }, "date_to": { "type": "string", "description": "date_to", "format": "date-time", "nullable": true, "readOnly": true }, "date_from": { "type": "string", "description": "date_from", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ReportNomenclatureProfitResultAttributesForExport": { "type": "object", "properties": { "include_name": { "type": "boolean", "description": "include_name" }, "include_category": { "type": "boolean", "description": "include_category" }, "include_uom_name": { "type": "boolean", "description": "include_uom_name" }, "include_sale_price": { "type": "boolean", "description": "include_sale_price" }, "include_purchase_price": { "type": "boolean", "description": "include_purchase_price" }, "include_markup_amount_value": { "type": "boolean", "description": "include_markup_amount_value" }, "include_markup_amount_percentage": { "type": "boolean", "description": "include_markup_amount_percentage" }, "include_net_sales_quantity": { "type": "boolean", "description": "include_net_sales_quantity" }, "include_purchase_amount": { "type": "boolean", "description": "include_purchase_amount" }, "include_revenue_amount": { "type": "boolean", "description": "include_revenue_amount" }, "include_profit_amount": { "type": "boolean", "description": "include_profit_amount" }, "include_total_revenue_amount": { "type": "boolean", "description": "include_total_revenue_amount" }, "include_total_profit_amount": { "type": "boolean", "description": "include_total_profit_amount" } }, "additionalProperties": false }, "ReportNomenclatureProfitResultExportParams": { "type": "object", "properties": { "attributes_for_export": { "$ref": "#/components/schemas/ReportNomenclatureProfitResultAttributesForExport" }, "filters_for_export": { "$ref": "#/components/schemas/ReportNomenclatureProfitResultFiltersForExport" } }, "additionalProperties": false }, "ReportNomenclatureProfitResultFiltersForExport": { "type": "object", "properties": { "good_category_guid": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "good_category_guid", "nullable": true }, "outlet_guid": { "type": "string", "description": "outlet_guid", "format": "uuid", "nullable": true }, "warehouse_guid": { "type": "string", "description": "warehouse_guid", "format": "uuid", "nullable": true }, "date_from": { "type": "string", "description": "date_from", "format": "date-time", "nullable": true, "readOnly": true }, "date_to": { "type": "string", "description": "date_to", "format": "date-time", "nullable": true, "readOnly": true }, "current_period_from": { "type": "string", "description": "current_period_from", "format": "date-time", "nullable": true }, "current_period_to": { "type": "string", "description": "current_period_to", "format": "date-time", "nullable": true }, "previous_period_from": { "type": "string", "description": "previous_period_from", "format": "date-time", "nullable": true }, "previous_period_to": { "type": "string", "description": "previous_period_to", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ReportNomenclatureProfitResultItem": { "type": "object", "properties": { "good_guid": { "type": "string", "description": "good_guid", "format": "uuid" }, "uom_guid": { "type": "string", "description": "uom_guid", "format": "uuid" }, "category": { "type": "string", "description": "category", "nullable": true }, "name": { "type": "string", "description": "name", "nullable": true }, "uom_name": { "type": "string", "description": "uom_name", "nullable": true }, "sale_price_amount": { "$ref": "#/components/schemas/Money" }, "purchase_price_amount": { "$ref": "#/components/schemas/Money" }, "markup_price_percent": { "type": "number", "description": "markup_price_percent", "format": "double" }, "markup_price_amount": { "$ref": "#/components/schemas/Money" }, "quantity_payment": { "type": "number", "description": "quantity_payment", "format": "double" }, "quantity_refund": { "type": "number", "description": "quantity_refund", "format": "double" }, "purchase_amount": { "$ref": "#/components/schemas/Money" }, "revenue_amount": { "$ref": "#/components/schemas/Money" }, "profit_amount": { "$ref": "#/components/schemas/Money" } }, "additionalProperties": false }, "ReportNomenclatureProfitResultItemPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportNomenclatureProfitResultItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ReportNomenclatureResultAttributesForExport": { "type": "object", "properties": { "include_name": { "type": "boolean", "description": "include_name" }, "include_sale_price": { "type": "boolean", "description": "include_sale_price" }, "include_sale_currency": { "type": "boolean", "description": "include_sale_currency" }, "include_uom_name": { "type": "boolean", "description": "include_uom_name" }, "include_quantity_payment": { "type": "boolean", "description": "include_quantity_payment" }, "include_quantity_refund": { "type": "boolean", "description": "include_quantity_refund" }, "include_revenue_amount": { "type": "boolean", "description": "include_revenue_amount" }, "include_refund_amount": { "type": "boolean", "description": "include_refund_amount" }, "include_is_patent": { "type": "boolean", "description": "include_is_patent" } }, "additionalProperties": false }, "ReportNomenclatureResultExportParams": { "type": "object", "properties": { "attributes_for_export": { "$ref": "#/components/schemas/ReportNomenclatureResultAttributesForExport" }, "filters_for_export": { "$ref": "#/components/schemas/ReportNomenclatureResultFiltersForExport" } }, "additionalProperties": false }, "ReportNomenclatureResultFiltersForExport": { "type": "object", "properties": { "outlet_guid": { "type": "string", "description": "outlet_guid", "format": "uuid", "nullable": true }, "employee_guid": { "type": "string", "description": "employee_guid", "format": "uuid", "nullable": true }, "date_from": { "type": "string", "description": "date_from", "format": "date-time", "nullable": true }, "date_to": { "type": "string", "description": "date_to", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ReportNomenclatureResultItem": { "type": "object", "properties": { "name": { "type": "string", "description": "name", "nullable": true }, "sale_price": { "$ref": "#/components/schemas/Money" }, "uom": { "$ref": "#/components/schemas/UomReference" }, "quantity_payment": { "type": "number", "description": "quantity_payment", "format": "double" }, "quantity_refund": { "type": "number", "description": "quantity_refund", "format": "double" }, "revenue_amount": { "$ref": "#/components/schemas/Money" }, "refund_amount": { "$ref": "#/components/schemas/Money" }, "is_patent": { "type": "boolean", "description": "is_patent" } }, "additionalProperties": false }, "ReportNomenclatureResultItemPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportNomenclatureResultItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ReportNomenclatureStocksLimitsResultAttributesForExport": { "type": "object", "properties": { "include_good_name_column": { "type": "boolean", "description": "include_good_name_column" }, "include_goods_category_column": { "type": "boolean", "description": "include_goods_category_column" }, "include_good_barcodes_local_column": { "type": "boolean", "description": "include_good_barcodes_local_column" }, "include_good_barcodes_column": { "type": "boolean", "description": "include_good_barcodes_column" }, "include_minimum_balance_column": { "type": "boolean", "description": "include_minimum_balance_column" }, "include_stock_balance_column": { "type": "boolean", "description": "include_stock_balance_column" }, "include_outlet_name_column": { "type": "boolean", "description": "include_outlet_name_column" }, "include_uom_name_column": { "type": "boolean", "description": "include_uom_name_column" } }, "additionalProperties": false }, "ReportNomenclatureStocksLimitsResultExportParams": { "type": "object", "properties": { "attributes_for_export": { "$ref": "#/components/schemas/ReportNomenclatureStocksLimitsResultAttributesForExport" }, "filters_for_export": { "$ref": "#/components/schemas/ReportNomenclatureStocksLimitsResultFiltersForExport" } }, "additionalProperties": false }, "ReportNomenclatureStocksLimitsResultFiltersForExport": { "type": "object", "properties": { "good_category_guid": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "good_category_guid", "nullable": true }, "warehouse_guid": { "type": "string", "description": "warehouse_guid", "format": "uuid", "nullable": true }, "date_from": { "type": "string", "description": "date_from", "format": "date-time", "nullable": true, "readOnly": true }, "date_to": { "type": "string", "description": "date_to", "format": "date-time", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ReportPaymentAndRefundAttributesForExport": { "type": "object", "properties": { "include_legal_entity_name": { "type": "boolean", "description": "include_legal_entity_name" }, "include_outlet_name": { "type": "boolean", "description": "include_outlet_name" }, "include_workplace_name": { "type": "boolean", "description": "include_workplace_name" }, "include_employee_name": { "type": "boolean", "description": "include_employee_name" }, "include_customer_name": { "type": "boolean", "description": "include_customer_name" }, "include_customer_contacts": { "type": "boolean", "description": "include_customer_contacts" }, "include_deal_number": { "type": "boolean", "description": "include_deal_number" }, "include_processed_at": { "type": "boolean", "description": "include_processed_at" }, "include_opened_at": { "type": "boolean", "description": "include_opened_at" }, "include_operation_status": { "type": "boolean", "description": "include_operation_status" }, "include_shipment_status": { "type": "boolean", "description": "include_shipment_status" }, "include_sale_status": { "type": "boolean", "description": "include_sale_status" }, "include_sale_action_type": { "type": "boolean", "description": "include_sale_action_type" }, "include_positions": { "type": "boolean", "description": "include_positions" }, "include_total_sum": { "type": "boolean", "description": "include_total_sum" }, "include_cash_part_amount": { "type": "boolean", "description": "include_cash_part_amount" }, "include_card_part_amount": { "type": "boolean", "description": "include_card_part_amount" }, "include_sbp_part_amount": { "type": "boolean", "description": "include_sbp_part_amount" }, "include_other_part_amount": { "type": "boolean", "description": "include_other_part_amount" }, "include_fiscalization_flag": { "type": "boolean", "description": "include_fiscalization_flag" } }, "additionalProperties": false }, "ReportPaymentAndRefundExportParams": { "type": "object", "properties": { "attributes_for_export": { "$ref": "#/components/schemas/ReportPaymentAndRefundAttributesForExport" }, "filters_for_export": { "$ref": "#/components/schemas/OperationReportFiltersForExport" } }, "additionalProperties": false }, "ReportPaymentAndRefundItem": { "type": "object", "properties": { "legal_entity": { "$ref": "#/components/schemas/LegalEntityReference" }, "outlet": { "$ref": "#/components/schemas/OutletReference" }, "workplace": { "$ref": "#/components/schemas/WorkplaceReference" }, "employee": { "$ref": "#/components/schemas/EmployeeReference" }, "customer_name": { "type": "string", "description": "customer_name", "nullable": true }, "customer_contacts": { "type": "string", "description": "customer_contacts", "nullable": true }, "deal_number": { "type": "string", "description": "deal_number", "nullable": true }, "processed_at": { "type": "string", "description": "processed_at", "format": "date-time", "nullable": true }, "opened_at": { "type": "string", "description": "opened_at", "format": "date-time", "nullable": true }, "operation_status": { "type": "string", "description": "operation_status", "nullable": true }, "shipment_status": { "type": "string", "description": "shipment_status", "nullable": true }, "sale_status": { "type": "string", "description": "sale_status", "nullable": true }, "sale_action_type": { "type": "string", "description": "sale_action_type", "nullable": true }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/DealPosition" }, "description": "positions", "nullable": true }, "total_sum": { "type": "integer", "description": "total_sum", "format": "int64" }, "cash_part_amount": { "type": "integer", "description": "cash_part_amount", "format": "int64", "nullable": true }, "card_part_amount": { "type": "integer", "description": "card_part_amount", "format": "int64", "nullable": true }, "sbp_part_amount": { "type": "integer", "description": "sbp_part_amount", "format": "int64", "nullable": true }, "other_part_amount": { "type": "integer", "description": "other_part_amount", "format": "int64", "nullable": true }, "fiscalization_flag": { "type": "boolean", "description": "fiscalization_flag" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ReportPaymentAndRefundItemPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportPaymentAndRefundItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ReportTransactionAttributesForExport": { "type": "object", "properties": { "include_legal_entity_name": { "type": "boolean", "description": "include_legal_entity_name" }, "include_outlet_name": { "type": "boolean", "description": "include_outlet_name" }, "include_workplace_name": { "type": "boolean", "description": "include_workplace_name" }, "include_employee_name": { "type": "boolean", "description": "include_employee_name" }, "include_customer_name": { "type": "boolean", "description": "include_customer_name" }, "include_customer_contacts": { "type": "boolean", "description": "include_customer_contacts" }, "include_deal_number": { "type": "boolean", "description": "include_deal_number" }, "include_registered_at": { "type": "boolean", "description": "include_registered_at" }, "include_opened_at": { "type": "boolean", "description": "include_opened_at" }, "include_operation_status": { "type": "boolean", "description": "include_operation_status" }, "include_shipment_status": { "type": "boolean", "description": "include_shipment_status" }, "include_sale_status": { "type": "boolean", "description": "include_sale_status" }, "include_operation": { "type": "boolean", "description": "include_operation" }, "include_authorized_amount": { "type": "boolean", "description": "include_authorized_amount" }, "include_transaction_type_discriminator": { "type": "boolean", "description": "include_transaction_type_discriminator" }, "include_card_number": { "type": "boolean", "description": "include_card_number" }, "include_rrn": { "type": "boolean", "description": "include_rrn" }, "include_authorization_code": { "type": "boolean", "description": "include_authorization_code" }, "include_term_id": { "type": "boolean", "description": "include_term_id" } }, "additionalProperties": false }, "ReportTransactionExportParams": { "type": "object", "properties": { "attributes_for_export": { "$ref": "#/components/schemas/ReportTransactionAttributesForExport" }, "filters_for_export": { "$ref": "#/components/schemas/OperationReportFiltersForExport" } }, "additionalProperties": false }, "ReportTransactionItem": { "type": "object", "properties": { "legal_entity": { "$ref": "#/components/schemas/LegalEntityReference" }, "outlet": { "$ref": "#/components/schemas/OutletReference" }, "workplace": { "$ref": "#/components/schemas/WorkplaceReference" }, "employee": { "$ref": "#/components/schemas/EmployeeReference" }, "customer_name": { "type": "string", "description": "customer_name", "nullable": true }, "customer_contacts": { "type": "string", "description": "customer_contacts", "nullable": true }, "deal_number": { "type": "string", "description": "deal_number", "nullable": true }, "registered_at": { "type": "string", "description": "registered_at", "format": "date-time", "nullable": true }, "opened_at": { "type": "string", "description": "opened_at", "format": "date-time", "nullable": true }, "operation_status": { "type": "string", "description": "operation_status", "nullable": true }, "shipment_status": { "type": "string", "description": "shipment_status", "nullable": true }, "sale_status": { "type": "string", "description": "sale_status", "nullable": true }, "operation": { "$ref": "#/components/schemas/TransactionOperationTypes" }, "authorized_amount": { "type": "integer", "description": "authorized_amount", "format": "int64", "nullable": true }, "transaction_type_discriminator": { "type": "string", "description": "transaction_type_discriminator", "nullable": true }, "card_number": { "type": "string", "description": "card_number", "nullable": true }, "rrn": { "type": "string", "description": "rrn", "nullable": true }, "authorization_code": { "type": "string", "description": "authorization_code", "nullable": true }, "term_id": { "type": "string", "description": "term_id", "nullable": true }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ReportTransactionItemPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTransactionItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ResetCredentials": { "required": [ "confirmation_code", "password", "phone" ], "type": "object", "properties": { "phone": { "maxLength": 18, "minLength": 10, "pattern": "((8|\\+7)-?)?\\(?\\d{3,5}\\)?-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}((-?\\d{1})?-?\\d{1})?", "type": "string", "description": "phone" }, "password": { "maxLength": 32, "minLength": 6, "type": "string", "description": "password" }, "confirmation_code": { "maxLength": 6, "minLength": 6, "pattern": "^\\d+$", "type": "string", "description": "confirmation_code" } }, "additionalProperties": false }, "ResetPasswordResponse": { "type": "object", "properties": { "password": { "type": "string", "description": "password", "nullable": true } }, "additionalProperties": false }, "ResetPinCodeCredentials": { "required": [ "confirmation_code", "phone" ], "type": "object", "properties": { "phone": { "maxLength": 18, "minLength": 10, "pattern": "((8|\\+7)-?)?\\(?\\d{3,5}\\)?-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}((-?\\d{1})?-?\\d{1})?", "type": "string", "description": "phone" }, "confirmation_code": { "maxLength": 6, "minLength": 6, "pattern": "^\\d+$", "type": "string", "description": "confirmation_code" } }, "additionalProperties": false }, "Resolution": { "type": "object", "properties": { "message": { "type": "string", "description": "message", "nullable": true }, "type": { "$ref": "#/components/schemas/ResolutionTypes" } }, "additionalProperties": false }, "ResolutionTypes": { "enum": [ "Information", "Warning", "Error" ], "type": "string" }, "RetailAppDealExtension": { "required": [ "version" ], "type": "object", "properties": { "deal_permissions": { "type": "array", "items": { "$ref": "#/components/schemas/RetailAppDealRolePermissions" }, "description": "deal_permissions", "nullable": true }, "deal_position_permissions": { "type": "array", "items": { "$ref": "#/components/schemas/RetailAppDealPositionRolePermissions" }, "description": "deal_position_permissions", "nullable": true }, "use_shipment_instead_of_payment": { "type": "boolean", "description": "use_shipment_instead_of_payment" }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "RetailAppDealPositionRolePermissions": { "required": [ "position", "role" ], "type": "object", "properties": { "position": { "$ref": "#/components/schemas/DealPositionReference" }, "role": { "$ref": "#/components/schemas/RoleReference" }, "can_edit_name": { "type": "boolean", "description": "can_edit_name", "default": false }, "can_edit_good_type": { "type": "boolean", "description": "can_edit_good_type", "default": false }, "can_edit_uom": { "type": "boolean", "description": "can_edit_uom", "default": false }, "can_edit_quantity": { "type": "boolean", "description": "can_edit_quantity", "default": false }, "can_edit_tax": { "type": "boolean", "description": "can_edit_tax", "default": false }, "can_edit_sale_price": { "type": "boolean", "description": "can_edit_sale_price", "default": false }, "can_delete": { "type": "boolean", "description": "can_delete", "default": false }, "allowed_max_quantity": { "maximum": 10000000, "minimum": 0, "type": "number", "description": "allowed_max_quantity", "format": "double" }, "allowed_min_quantity": { "maximum": 10000000, "minimum": 0, "type": "number", "description": "allowed_min_quantity", "format": "double" }, "allowed_max_sale_price": { "$ref": "#/components/schemas/Money" }, "allowed_min_sale_price": { "$ref": "#/components/schemas/Money" } }, "additionalProperties": false }, "RetailAppDealRolePermissions": { "required": [ "role" ], "type": "object", "properties": { "role": { "$ref": "#/components/schemas/RoleReference" }, "can_edit_comment": { "type": "boolean", "description": "can_edit_comment", "default": false }, "can_edit_customer_name": { "type": "boolean", "description": "can_edit_customer_name", "default": false }, "can_edit_customer_contacts": { "type": "boolean", "description": "can_edit_customer_contacts", "default": false }, "can_edit_customer_inn": { "type": "boolean", "description": "can_edit_customer_inn", "default": false }, "can_add_offer_position": { "type": "boolean", "description": "can_add_offer_position", "default": false }, "can_add_free_position": { "type": "boolean", "description": "can_add_free_position", "default": false }, "can_delete": { "type": "boolean", "description": "can_delete", "default": false }, "can_refund": { "type": "boolean", "description": "can_refund", "default": false }, "can_cancel": { "type": "boolean", "description": "can_cancel", "default": false } }, "additionalProperties": false }, "RetailAppModes": { "enum": [ "Full", "Lite" ], "type": "string" }, "RetailAppOutletExtension": { "required": [ "version" ], "type": "object", "properties": { "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/RetailAppOutletRolePermissions" }, "description": "permissions", "nullable": true }, "mandatory_sales_filter_by_current_employee": { "type": "boolean", "description": "mandatory_sales_filter_by_current_employee", "nullable": true }, "mandatory_sales_filter_by_current_workplace": { "type": "boolean", "description": "mandatory_sales_filter_by_current_workplace", "nullable": true }, "mode": { "$ref": "#/components/schemas/RetailAppModes" }, "fiscalization_turned_on": { "type": "boolean", "description": "fiscalization_turned_on", "nullable": true }, "fast_payment_acceptance_turned_on": { "type": "boolean", "description": "fast_payment_acceptance_turned_on", "nullable": true }, "mandatory_sync_after_payment_turned_on": { "type": "boolean", "description": "mandatory_sync_after_payment_turned_on", "nullable": true }, "local_sales_report_turned_on": { "type": "boolean", "description": "local_sales_report_turned_on", "nullable": true }, "check_marking_code_turned_on": { "type": "boolean", "description": "check_marking_code_turned_on", "nullable": true }, "receipt_before_payment_turned_on": { "type": "boolean", "description": "receipt_before_payment_turned_on", "nullable": true }, "default_item_add_method": { "$ref": "#/components/schemas/DefaultAddMethodRole" }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "RetailAppOutletRolePermissions": { "required": [ "role" ], "type": "object", "properties": { "role": { "$ref": "#/components/schemas/RoleReference" }, "can_open_new_sale": { "type": "boolean", "description": "can_open_new_sale", "default": false }, "can_add_free_position_to_sale": { "type": "boolean", "description": "can_add_free_position_to_sale", "default": false }, "can_add_positions_using_scanner": { "type": "boolean", "description": "can_add_positions_using_scanner", "default": false }, "can_add_positions_from_catalog": { "type": "boolean", "description": "can_add_positions_from_catalog", "default": false }, "can_register_correction_receipt": { "type": "boolean", "description": "can_register_correction_receipt", "default": false }, "can_refund_sales": { "type": "boolean", "description": "can_refund_sales", "default": true }, "can_print_slip_copy": { "type": "boolean", "description": "can_print_slip_copy", "default": false }, "can_print_receipt_copy": { "type": "boolean", "description": "can_print_receipt_copy", "default": false }, "can_manage_catalog": { "type": "boolean", "description": "can_manage_catalog", "default": false }, "default_preferred_input_method": { "$ref": "#/components/schemas/RetailAppPreferredInputMethods" } }, "additionalProperties": false }, "RetailAppPreferredInputMethods": { "enum": [ "Catalog", "Scanner", "FreePosition" ], "type": "string" }, "RevenueByEmployeesPeriodsReportItem": { "type": "object", "properties": { "employee": { "$ref": "#/components/schemas/EmployeeReference" }, "periods": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueByPeriodsReportItem" }, "description": "periods", "nullable": true }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueByEmployeesReportItem": { "type": "object", "properties": { "employee": { "$ref": "#/components/schemas/EmployeeReference" }, "summary": { "$ref": "#/components/schemas/RevenueSummary" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueByOutletsPeriodsReportItem": { "type": "object", "properties": { "outlet": { "$ref": "#/components/schemas/OutletReference" }, "periods": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueByPeriodsReportItem" }, "description": "periods", "nullable": true }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueByOutletsReportItem": { "type": "object", "properties": { "outlet": { "$ref": "#/components/schemas/OutletReference" }, "summary": { "$ref": "#/components/schemas/RevenueSummary" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueByPeriodsAndEmployeesReportItem": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/RevenueByPeriodsType" }, "date": { "type": "string", "description": "date", "format": "date-time" }, "employee": { "$ref": "#/components/schemas/EmployeeReference" }, "summary": { "$ref": "#/components/schemas/RevenueSummary" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueByPeriodsAndOutletsReportItem": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/RevenueByPeriodsType" }, "date": { "type": "string", "description": "date", "format": "date-time" }, "outlet": { "$ref": "#/components/schemas/OutletReference" }, "summary": { "$ref": "#/components/schemas/RevenueSummary" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueByPeriodsReportItem": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/RevenueByPeriodsType" }, "date": { "type": "string", "description": "date", "format": "date-time" }, "summary": { "$ref": "#/components/schemas/RevenueSummary" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueByPeriodsType": { "enum": [ "Year", "Quarter", "Month", "Week", "Day", "Hour" ], "type": "string" }, "RevenueReportForEmployeesWidget": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueReportForEmployeesWidgetItem" }, "description": "items" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueReportForEmployeesWidgetItem": { "required": [ "current_summary", "employee", "growth_rate", "previous_summary" ], "type": "object", "properties": { "employee": { "$ref": "#/components/schemas/EmployeeReference" }, "current_summary": { "$ref": "#/components/schemas/RevenueSummary" }, "previous_summary": { "$ref": "#/components/schemas/RevenueSummary" }, "growth_rate": { "$ref": "#/components/schemas/GrowthRate" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueReportForOutletsWidget": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueReportForOutletsWidgetItem" }, "description": "items", "nullable": true }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueReportForOutletsWidgetItem": { "required": [ "current_summary", "growth_rate", "outlet", "previous_summary" ], "type": "object", "properties": { "outlet": { "$ref": "#/components/schemas/OutletReference" }, "current_summary": { "$ref": "#/components/schemas/RevenueSummary" }, "previous_summary": { "$ref": "#/components/schemas/RevenueSummary" }, "growth_rate": { "$ref": "#/components/schemas/GrowthRate" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueReportForWidget": { "required": [ "current_summary", "growth_rate", "previous_summary" ], "type": "object", "properties": { "current_summary": { "$ref": "#/components/schemas/RevenueSummary" }, "previous_summary": { "$ref": "#/components/schemas/RevenueSummary" }, "growth_rate": { "$ref": "#/components/schemas/GrowthRate" } }, "additionalProperties": false }, "RevenueReportsAttributesForExport": { "type": "object", "properties": { "include_outlet_name": { "type": "boolean", "description": "include_outlet_name" }, "include_employee_name": { "type": "boolean", "description": "include_employee_name" }, "include_period_column": { "type": "boolean", "description": "include_period_column" }, "include_start_column": { "type": "boolean", "description": "include_start_column" }, "include_end_column": { "type": "boolean", "description": "include_end_column" }, "include_selection_points_column": { "type": "boolean", "description": "include_selection_points_column" }, "include_comparison_period_column": { "type": "boolean", "description": "include_comparison_period_column" }, "include_revenue_column": { "type": "boolean", "description": "include_revenue_column" }, "include_average_column": { "type": "boolean", "description": "include_average_column" }, "include_refunds_column": { "type": "boolean", "description": "include_refunds_column" }, "include_payments_column": { "type": "boolean", "description": "include_payments_column" }, "include_number_of_payments_column": { "type": "boolean", "description": "include_number_of_payments_column" }, "include_number_of_refunds_column": { "type": "boolean", "description": "include_number_of_refunds_column" }, "include_number_of_transactions_column": { "type": "boolean", "description": "include_number_of_transactions_column" }, "include_median_payments_column": { "type": "boolean", "description": "include_median_payments_column" } }, "additionalProperties": false }, "RevenueReportsExportParams": { "type": "object", "properties": { "attributes_for_export": { "$ref": "#/components/schemas/RevenueReportsAttributesForExport" }, "filters_for_export": { "$ref": "#/components/schemas/RevenueReportsFiltersForExport" } }, "additionalProperties": false }, "RevenueReportsExportTask": { "required": [ "report_export_type" ], "type": "object", "properties": { "mime_type": { "type": "string", "description": "mime_type", "nullable": true, "readOnly": true }, "report_export_type": { "$ref": "#/components/schemas/ReportExportType" }, "parameters": { "$ref": "#/components/schemas/RevenueReportsExportParams" }, "status": { "$ref": "#/components/schemas/AsyncTaskStatuses" }, "progress": { "type": "integer", "description": "progress", "format": "int32" }, "resolutions": { "type": "array", "items": { "$ref": "#/components/schemas/Resolution" }, "description": "resolutions", "nullable": true }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueReportsExportTaskPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueReportsExportTask" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueReportsFiltersForExport": { "required": [ "revenueByPeriodsType" ], "type": "object", "properties": { "processed_at_from": { "type": "string", "description": "processed_at_from", "format": "date-time", "nullable": true }, "processed_at_to": { "type": "string", "description": "processed_at_to", "format": "date-time", "nullable": true }, "comparison_processed_at_from": { "type": "string", "description": "comparison_processed_at_from", "format": "date-time", "nullable": true }, "comparison_processed_at_to": { "type": "string", "description": "comparison_processed_at_to", "format": "date-time", "nullable": true }, "revenueByPeriodsType": { "$ref": "#/components/schemas/RevenueByPeriodsType" }, "outlet_guid": { "type": "string", "description": "outlet_guid", "format": "uuid", "nullable": true }, "outlet_guids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guids", "nullable": true }, "employee_guid": { "type": "string", "description": "employee_guid", "format": "uuid", "nullable": true }, "employee_guids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "employee_guids", "nullable": true } }, "additionalProperties": false }, "RevenueShare": { "type": "object", "properties": { "by_sum": { "type": "number", "description": "by_sum", "format": "double" }, "by_count": { "type": "number", "description": "by_count", "format": "double" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueSummary": { "type": "object", "properties": { "count": { "$ref": "#/components/schemas/RevenueSummaryQuantitativeMetric" }, "sum": { "$ref": "#/components/schemas/RevenueSummaryMonetaryMetric" }, "average": { "$ref": "#/components/schemas/RevenueSummaryMonetaryMetric" }, "median": { "$ref": "#/components/schemas/RevenueSummaryMonetaryMetric" }, "share": { "$ref": "#/components/schemas/RevenueSummaryShareMetric" }, "period": { "$ref": "#/components/schemas/RevenueSummaryPeriod" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueSummaryMonetaryMetric": { "type": "object", "properties": { "payments": { "$ref": "#/components/schemas/Money" }, "refunds": { "$ref": "#/components/schemas/Money" }, "total": { "$ref": "#/components/schemas/Money" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueSummaryPeriod": { "type": "object", "properties": { "date_from": { "type": "string", "description": "date_from", "format": "date-time" }, "date_to": { "type": "string", "description": "date_to", "format": "date-time" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueSummaryQuantitativeMetric": { "type": "object", "properties": { "payments": { "type": "integer", "description": "payments", "format": "int64" }, "refunds": { "type": "integer", "description": "refunds", "format": "int64" }, "total": { "type": "integer", "description": "total", "format": "int64" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueSummaryRevenueByEmployeesPeriodsReportItemPageSummary": { "type": "object", "properties": { "for_all_objects": { "$ref": "#/components/schemas/RevenueSummary" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueByEmployeesPeriodsReportItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueSummaryRevenueByEmployeesReportItemPageSummary": { "type": "object", "properties": { "for_all_objects": { "$ref": "#/components/schemas/RevenueSummary" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueByEmployeesReportItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueSummaryRevenueByOutletsPeriodsReportItemPageSummary": { "type": "object", "properties": { "for_all_objects": { "$ref": "#/components/schemas/RevenueSummary" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueByOutletsPeriodsReportItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueSummaryRevenueByOutletsReportItemPageSummary": { "type": "object", "properties": { "for_all_objects": { "$ref": "#/components/schemas/RevenueSummary" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueByOutletsReportItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueSummaryRevenueByPeriodsAndEmployeesReportItemPageSummary": { "type": "object", "properties": { "for_all_objects": { "$ref": "#/components/schemas/RevenueSummary" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueByPeriodsAndEmployeesReportItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueSummaryRevenueByPeriodsAndOutletsReportItemPageSummary": { "type": "object", "properties": { "for_all_objects": { "$ref": "#/components/schemas/RevenueSummary" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueByPeriodsAndOutletsReportItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueSummaryRevenueByPeriodsReportItemPageSummary": { "type": "object", "properties": { "for_all_objects": { "$ref": "#/components/schemas/RevenueSummary" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueByPeriodsReportItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RevenueSummaryShareMetric": { "type": "object", "properties": { "payments": { "$ref": "#/components/schemas/RevenueShare" }, "refunds": { "$ref": "#/components/schemas/RevenueShare" }, "total": { "$ref": "#/components/schemas/RevenueShare" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "ReversalCorrectionSaleSession": { "type": "object", "properties": { "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "correction_data": { "$ref": "#/components/schemas/CorrectionData" }, "sale": { "$ref": "#/components/schemas/SaleReference" }, "actions": { "$ref": "#/components/schemas/SaleActions" }, "fiscal_documents": { "type": "array", "items": { "$ref": "#/components/schemas/IFiscalDocumentReference" }, "description": "fiscal_documents", "nullable": true }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "ReversalSaleSession": { "type": "object", "properties": { "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "sale": { "$ref": "#/components/schemas/SaleReference" }, "actions": { "$ref": "#/components/schemas/SaleActions" }, "fiscal_documents": { "type": "array", "items": { "$ref": "#/components/schemas/IFiscalDocumentReference" }, "description": "fiscal_documents", "nullable": true }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "Role": { "required": [ "name", "role_type" ], "type": "object", "properties": { "name": { "maxLength": 32, "minLength": 1, "type": "string", "description": "name" }, "role_type": { "$ref": "#/components/schemas/RoleTypes" }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RoleAccessFeature": { "required": [ "feature", "name", "path" ], "type": "object", "properties": { "feature": { "minLength": 1, "type": "string", "description": "feature" }, "name": { "minLength": 1, "type": "string", "description": "name" }, "path": { "minLength": 1, "type": "string", "description": "path" } }, "additionalProperties": false }, "RoleAccessGroup": { "required": [ "features", "group", "name" ], "type": "object", "properties": { "group": { "minLength": 1, "type": "string", "description": "group" }, "name": { "minLength": 1, "type": "string", "description": "name" }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAccessFeature" }, "description": "features" } }, "additionalProperties": false }, "RolePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Role" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RoleReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "RoleTypes": { "enum": [ "BuiltIn", "Custom" ], "type": "string" }, "Sale": { "required": [ "number", "opened_at", "opened_by", "outlet", "total_sum" ], "type": "object", "properties": { "outlet": { "$ref": "#/components/schemas/OutletReference" }, "workplace": { "$ref": "#/components/schemas/WorkplaceReference" }, "opened_by": { "$ref": "#/components/schemas/EmployeeReference" }, "opened_at": { "type": "string", "description": "opened_at", "format": "date-time" }, "number": { "maxLength": 36, "minLength": 1, "type": "string", "description": "number" }, "comment": { "maxLength": 512, "type": "string", "description": "comment", "nullable": true }, "state": { "$ref": "#/components/schemas/DealStates" }, "payment_status": { "$ref": "#/components/schemas/DealPaymentStatus" }, "shipping_status": { "$ref": "#/components/schemas/DealShippingStatus" }, "total_sum": { "$ref": "#/components/schemas/Money" }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/DealPosition" }, "description": "positions", "nullable": true }, "customer_data": { "$ref": "#/components/schemas/CustomerData" }, "additional_attributes": { "$ref": "#/components/schemas/AdditionalDealAttributes" }, "source_type": { "$ref": "#/components/schemas/SourceType" }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "extensions": { "title": "SaleExtensions", "properties": { "retail_app": { "$ref": "#/components/schemas/RetailAppDealExtension" }, "payment_methods": { "$ref": "#/components/schemas/PaymentMethodsSaleExtension" }, "payment_recipients": { "$ref": "#/components/schemas/PaymentRecipientsSaleExtension" }, "discounts": { "$ref": "#/components/schemas/DiscountsSaleExtension" } }, "description": "Расширения" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "SaleActions": { "type": "object", "properties": { "money_action": { "$ref": "#/components/schemas/MoneyAction" }, "non_purpose_money_action": { "$ref": "#/components/schemas/NonPurposeMoneyAction" }, "shipping_action": { "$ref": "#/components/schemas/ShippingAction" } }, "additionalProperties": false }, "SaleExtensions": { "title": "SaleExtensions", "properties": { "retail_app": { "$ref": "#/components/schemas/RetailAppDealExtension" }, "payment_methods": { "$ref": "#/components/schemas/PaymentMethodsSaleExtension" }, "payment_recipients": { "$ref": "#/components/schemas/PaymentRecipientsSaleExtension" }, "discounts": { "$ref": "#/components/schemas/DiscountsSaleExtension" } }, "description": "Расширения" }, "SalePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Sale" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "SaleReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "SelectionModes": { "enum": [ "alive_only", "archived_only", "all" ], "type": "string" }, "SendCodeByPhoneCredentials": { "required": [ "phone" ], "type": "object", "properties": { "phone": { "maxLength": 18, "minLength": 10, "pattern": "((8|\\+7)-?)?\\(?\\d{3,5}\\)?-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}((-?\\d{1})?-?\\d{1})?", "type": "string", "description": "phone" }, "token": { "type": "string", "description": "token", "nullable": true }, "ip": { "type": "string", "description": "ip", "nullable": true }, "captcha_type": { "$ref": "#/components/schemas/CaptchaType" }, "send_sms": { "type": "boolean", "description": "send_sms", "nullable": true } }, "additionalProperties": false }, "SendCodeByUsernameCredentials": { "required": [ "full_username" ], "type": "object", "properties": { "full_username": { "maxLength": 49, "minLength": 5, "type": "string", "description": "full_username" } }, "additionalProperties": false }, "SettlementSubjects": { "enum": [ "Product", "ExciseProduct", "Work", "Service", "GamblingBet", "GamblingWinning", "LotteryBet", "LotteryWinning", "IntellectualProperty", "Payment", "AgentFee", "Payout", "Other", "PropertyRights", "NonRealizationIncome", "OtherPayments", "TradeFee", "ResortFee", "Bail", "Outflow", "ContributionForOPSIP", "ContributionForOPS", "ContributionForOMSIP", "ContributionForOMS", "ContributionForOSS", "CasinoPayment", "Cashout", "ATNM", "ATM", "TNM", "TM" ], "type": "string" }, "ShippingAction": { "type": "object", "properties": { "purposes": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingActionPurpose" }, "description": "purposes", "nullable": true }, "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "modified_at": { "type": "string", "description": "modified_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "ShippingActionPurpose": { "required": [ "quantity" ], "type": "object", "properties": { "type_of": { "type": "string", "description": "type_of", "nullable": true, "readOnly": true }, "quantity": { "type": "number", "description": "quantity", "format": "double" }, "marking_attributes": { "$ref": "#/components/schemas/MarkingAttributes" }, "position": { "$ref": "#/components/schemas/DealPositionReference" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" } }, "additionalProperties": false }, "SignInByPhone": { "required": [ "password", "phone" ], "type": "object", "properties": { "phone": { "maxLength": 18, "minLength": 10, "pattern": "((8|\\+7)-?)?\\(?\\d{3,5}\\)?-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}((-?\\d{1})?-?\\d{1})?", "type": "string", "description": "phone" }, "password": { "maxLength": 32, "minLength": 6, "type": "string", "description": "password" } }, "additionalProperties": false }, "SignInCredentials": { "required": [ "full_username", "password" ], "type": "object", "properties": { "full_username": { "maxLength": 49, "minLength": 2, "type": "string", "description": "full_username" }, "password": { "maxLength": 32, "minLength": 6, "type": "string", "description": "password" }, "response_type": { "$ref": "#/components/schemas/AuthResponseType" } }, "additionalProperties": false }, "SignUpCredentials": { "required": [ "confirmation_code", "name", "phone" ], "type": "object", "properties": { "phone": { "maxLength": 18, "minLength": 10, "pattern": "((8|\\+7)-?)?\\(?\\d{3,5}\\)?-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}((-?\\d{1})?-?\\d{1})?", "type": "string", "description": "phone" }, "name": { "maxLength": 64, "minLength": 5, "type": "string", "description": "name" }, "initial_username": { "maxLength": 24, "minLength": 2, "pattern": "^[a-zA-Z0-9_-]{2,24}$", "type": "string", "description": "initial_username", "nullable": true }, "initial_password": { "maxLength": 32, "minLength": 6, "type": "string", "description": "initial_password", "nullable": true }, "confirmation_code": { "maxLength": 6, "minLength": 6, "pattern": "^\\d+$", "type": "string", "description": "confirmation_code" }, "email": { "maxLength": 64, "minLength": 6, "type": "string", "description": "email", "format": "email", "nullable": true }, "send_sms": { "type": "boolean", "description": "send_sms", "nullable": true } }, "additionalProperties": false }, "SoftPosWorkplaceExtension": { "required": [ "version" ], "type": "object", "properties": { "emv_config": { "maxLength": 10485760, "type": "string", "description": "emv_config", "nullable": true }, "tms_params": { "$ref": "#/components/schemas/LifepaySmartPosTmsParams" }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "SourceType": { "enum": [ "Pos", "Cloud", "Web" ], "type": "string" }, "SplitPaymentsAvailableMethods": { "type": "object", "properties": { "cash_payments_available": { "type": "boolean", "description": "cash_payments_available" }, "cashless_payments_available": { "type": "boolean", "description": "cashless_payments_available" }, "card_payments_available": { "type": "boolean", "description": "card_payments_available" }, "quick_payments_available": { "type": "boolean", "description": "quick_payments_available" } }, "additionalProperties": false }, "SubscriptionLicense": { "type": "object", "properties": { "name": { "type": "string", "description": "name", "nullable": true }, "plan": { "$ref": "#/components/schemas/SubscriptionPlanReference" }, "quantity": { "type": "integer", "description": "quantity", "format": "int32" }, "expires_at": { "type": "string", "description": "expires_at", "format": "date-time" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "SubscriptionLicenseApplication": { "required": [ "period_in_months", "plan", "quantity" ], "type": "object", "properties": { "plan": { "$ref": "#/components/schemas/SubscriptionPlanReference" }, "quantity": { "maximum": 100000, "minimum": 0, "type": "integer", "description": "quantity", "format": "int32" }, "period_in_months": { "maximum": 60, "minimum": 0, "type": "integer", "description": "period_in_months", "format": "int32" }, "who_pays": { "$ref": "#/components/schemas/LegalEntityReference" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "SubscriptionLicenseOffer": { "type": "object", "properties": { "plan": { "$ref": "#/components/schemas/SubscriptionPlanReference" }, "quantity": { "type": "integer", "description": "quantity", "format": "int32" }, "expires_at": { "type": "string", "description": "expires_at", "format": "date-time" }, "total_sum": { "$ref": "#/components/schemas/Money" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "SubscriptionPeriod": { "type": "object", "properties": { "period_in_months": { "type": "integer", "description": "period_in_months", "format": "int32" }, "price": { "$ref": "#/components/schemas/SubscriptionPeriodPrice" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "SubscriptionPeriodPrice": { "type": "object", "properties": { "final_price": { "$ref": "#/components/schemas/Money" }, "base_price": { "$ref": "#/components/schemas/Money" }, "final_price_per_month": { "$ref": "#/components/schemas/Money" }, "base_price_per_month": { "$ref": "#/components/schemas/Money" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "SubscriptionPlan": { "type": "object", "properties": { "code": { "type": "string", "description": "code", "nullable": true }, "name": { "type": "string", "description": "name", "nullable": true }, "features": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "features", "nullable": true }, "periods": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPeriod" }, "description": "periods", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "SubscriptionPlanReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "SubscriptionProduct": { "type": "object", "properties": { "code": { "type": "string", "description": "code", "nullable": true }, "name": { "type": "string", "description": "name", "nullable": true }, "plans": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPlan" }, "description": "plans", "nullable": true }, "acquired_license": { "$ref": "#/components/schemas/SubscriptionLicense" }, "last_paid_subscription_expired_at": { "type": "string", "description": "last_paid_subscription_expired_at", "format": "date-time", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "TaxSystems": { "enum": [ "Osn", "Usn", "UsnMinus", "Envd", "Esn", "Patent" ], "type": "string" }, "TechSupportContacts": { "required": [ "line", "responsibility" ], "type": "object", "properties": { "line": { "maxLength": 24, "minLength": 2, "type": "string", "description": "line" }, "responsibility": { "maxLength": 128, "minLength": 2, "type": "string", "description": "responsibility" }, "phone": { "maxLength": 18, "minLength": 10, "pattern": "((8|\\+7)-?)?\\(?\\d{3,5}\\)?-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}-?\\d{1}((-?\\d{1})?-?\\d{1})?", "type": "string", "description": "phone", "nullable": true }, "email": { "maxLength": 64, "minLength": 6, "pattern": "^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$", "type": "string", "description": "email", "nullable": true }, "opening_hours": { "maxLength": 128, "minLength": 2, "type": "string", "description": "opening_hours", "nullable": true }, "whatsapp": { "maxLength": 64, "minLength": 2, "type": "string", "description": "whatsapp", "nullable": true }, "viber": { "maxLength": 64, "minLength": 2, "type": "string", "description": "viber", "nullable": true }, "telegram": { "maxLength": 64, "minLength": 2, "type": "string", "description": "telegram", "nullable": true }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "TerminalOrderings": { "enum": [ "created_at_asc", "created_at_desc", "updated_at_asc", "updated_at_desc", "model_asc", "model_desc", "terminal_id_asc", "terminal_id_desc", "merchant_id_asc", "merchant_id_desc" ], "type": "string" }, "TransactionOperationTypes": { "enum": [ "Payment", "Cancellation", "Refund" ], "type": "string" }, "TransactionOrderings": { "enum": [ "created_at_asc", "created_at_desc", "updated_at_asc", "updated_at_desc", "operation_asc", "operation_desc", "registered_at_asc", "registered_at_desc", "amount_asc", "amount_desc" ], "type": "string" }, "UnifiedPersonalAccountExtension": { "required": [ "version" ], "type": "object", "properties": { "turned_on": { "type": "boolean", "description": "turned_on" }, "version": { "maxLength": 8, "minLength": 1, "type": "string", "description": "version" } }, "additionalProperties": false }, "Uom": { "required": [ "name", "symbol" ], "type": "object", "properties": { "name": { "maxLength": 32, "minLength": 2, "type": "string", "description": "name" }, "symbol": { "maxLength": 16, "minLength": 1, "type": "string", "description": "symbol" }, "is_fractional": { "type": "boolean", "description": "is_fractional" }, "code_ru_okei": { "maxLength": 4, "pattern": "^\\d+$", "type": "string", "description": "code_ru_okei", "nullable": true }, "code_unece": { "maxLength": 16, "type": "string", "description": "code_unece", "nullable": true }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "UomImportPreviewItem": { "type": "object", "properties": { "before": { "$ref": "#/components/schemas/Uom" }, "after": { "$ref": "#/components/schemas/Uom" } }, "additionalProperties": false }, "UomImportPreviewItemPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UomImportPreviewItem" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "UomOrderings": { "enum": [ "created_at_asc", "created_at_desc", "updated_at_asc", "updated_at_desc", "name_asc", "name_desc", "symbol_asc", "symbol_desc", "code_ru_okei_asc", "code_ru_okei_desc", "code_unece_asc", "code_unece_desc" ], "type": "string" }, "UomPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Uom" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "UomReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "UserAccess": { "type": "object", "properties": { "token": { "type": "string", "description": "token", "nullable": true } }, "additionalProperties": false }, "UserSetCredentials": { "required": [ "new_password", "old_password" ], "type": "object", "properties": { "old_password": { "maxLength": 32, "minLength": 6, "type": "string", "description": "old_password" }, "new_password": { "maxLength": 32, "minLength": 6, "type": "string", "description": "new_password" } }, "additionalProperties": false }, "ValueAddedTaxRates": { "enum": [ "Tax20", "Tax10", "Tax0", "TaxFree", "Tax5", "Tax7", "Tax22" ], "type": "string" }, "Workplace": { "required": [ "workplace_type" ], "type": "object", "properties": { "number": { "maximum": 99999, "minimum": 1, "type": "integer", "description": "number", "format": "int32", "nullable": true }, "name": { "maxLength": 128, "type": "string", "description": "name", "nullable": true }, "workplace_type": { "$ref": "#/components/schemas/WorkplaceTypes" }, "activated_at": { "type": "string", "description": "activated_at", "format": "date-time", "nullable": true }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "extensions": { "title": "WorkplaceExtensions", "properties": { "nadex_soft_pos": { "$ref": "#/components/schemas/NadexSoftPOSWorkplaceExtension" }, "smart_pos": { "$ref": "#/components/schemas/SoftPosWorkplaceExtension" }, "pay_quick_payments_dynamic": { "$ref": "#/components/schemas/PayQuickPaymentsDynamicExtensions" }, "pos_quick_payments": { "$ref": "#/components/schemas/PosQuickPaymentsWorkplaceExtensions" } }, "description": "Расширения" }, "created_at": { "type": "string", "description": "created_at", "format": "date-time" }, "updated_at": { "type": "string", "description": "updated_at", "format": "date-time" }, "deleted_at": { "type": "string", "description": "deleted_at", "format": "date-time", "nullable": true }, "meta": { "maxLength": 128, "type": "string", "description": "meta", "nullable": true }, "meta_data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "meta_data", "nullable": true }, "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "WorkplaceAccess": { "type": "object", "properties": { "token": { "type": "string", "description": "token", "nullable": true }, "workplace": { "$ref": "#/components/schemas/WorkplaceReference" }, "organization": { "$ref": "#/components/schemas/OrganizationReference" }, "outlet": { "$ref": "#/components/schemas/OutletReference" }, "employee": { "$ref": "#/components/schemas/EmployeeReference" } }, "additionalProperties": false }, "WorkplaceExtensions": { "title": "WorkplaceExtensions", "properties": { "nadex_soft_pos": { "$ref": "#/components/schemas/NadexSoftPOSWorkplaceExtension" }, "smart_pos": { "$ref": "#/components/schemas/SoftPosWorkplaceExtension" }, "pay_quick_payments_dynamic": { "$ref": "#/components/schemas/PayQuickPaymentsDynamicExtensions" }, "pos_quick_payments": { "$ref": "#/components/schemas/PosQuickPaymentsWorkplaceExtensions" } }, "description": "Расширения" }, "WorkplaceOrderings": { "enum": [ "created_at_asc", "created_at_desc", "updated_at_asc", "updated_at_desc", "number_asc", "number_desc", "name_asc", "name_desc", "workplace_type_asc", "workplace_type_desc", "activated_at_asc", "activated_at_desc" ], "type": "string" }, "WorkplacePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Workplace" }, "description": "items", "nullable": true }, "next_page_token": { "type": "string", "description": "next_page_token", "nullable": true }, "page_number": { "type": "integer", "description": "page_number", "format": "int32" }, "pages_total": { "type": "integer", "description": "pages_total", "format": "int32" }, "items_per_page": { "type": "integer", "description": "items_per_page", "format": "int32" }, "items_total": { "type": "integer", "description": "items_total", "format": "int32" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "WorkplaceReference": { "type": "object", "properties": { "guid": { "type": "string", "description": "guid", "format": "uuid" }, "type_of": { "type": "string", "description": "type_of" } }, "additionalProperties": false }, "WorkplaceTypes": { "enum": [ "Unknown", "Mobile", "Stationary", "Automat" ], "type": "string" } }, "securitySchemes": { "Bearer": { "type": "apiKey", "name": "Authorization", "in": "header" }, "OAuth2": { "type": "oauth2", "description": "DISABLED SECURITY DEFINITION. DO NOT USE.", "flows": { "authorizationCode": { "authorizationUrl": "https://localhost/disabled", "tokenUrl": "https://localhost/disabled", "scopes": { "owner": "Владелец", "administrator": "Администратор", "manager": "Менеджер", "cashier": "Кассир", "courier": "Курьер", "guest": "Гость" } } } } } }, "tags": [ { "name": "AsyncTasks" }, { "name": "Auth" }, { "name": "Brands" }, { "name": "DirectCorrectionSaleSessions" }, { "name": "DirectSaleSessions" }, { "name": "Employees" }, { "name": "Export" }, { "name": "FiscalDocuments" }, { "name": "FiscalRegistrars" }, { "name": "Goods" }, { "name": "GoodsCategories" }, { "name": "Import" }, { "name": "Invoices" }, { "name": "LegalEntities" }, { "name": "Me" }, { "name": "NomenclatureExport" }, { "name": "NomenclatureImport" }, { "name": "NomenclatureImportTaskPreview" }, { "name": "OperationsReport" }, { "name": "OperationsReportExport" }, { "name": "OrganizationOptions" }, { "name": "Organizations" }, { "name": "Outlets" }, { "name": "RevenueReports" }, { "name": "RevenueReportsExport" }, { "name": "RevenueReportsWidgets" }, { "name": "ReversalCorrectionSaleSessions" }, { "name": "ReversalSaleSessions" }, { "name": "Roles" }, { "name": "Sales" }, { "name": "SaleSessions" }, { "name": "Subscriptions" }, { "name": "Terminals" }, { "name": "Transactions" }, { "name": "Uoms" }, { "name": "Workplaces" } ] }