{ "openapi": "3.0.4", "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", "description": "include_permissions", "schema": { "type": "boolean", "description": "include_permissions" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "717e8f4a-96f2-4ba3-92aa-638152de062e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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":"72737c52-945e-4b9b-bab4-5bcada592285","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": "4d15bd1e-66d9-4253-91c1-1a57c4bfa6cc" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "current_period_from", "required": true, "schema": { "type": "string", "description": "current_period_from", "format": "date-time" } }, { "name": "current_period_to", "in": "query", "description": "current_period_to", "required": true, "schema": { "type": "string", "description": "current_period_to", "format": "date-time" } }, { "name": "previous_period_from", "in": "query", "description": "previous_period_from", "required": true, "schema": { "type": "string", "description": "previous_period_from", "format": "date-time" } }, { "name": "previous_period_to", "in": "query", "description": "previous_period_to", "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": "96dee60e-2323-44bd-967e-0688e58706d5" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "current_period_from", "required": true, "schema": { "type": "string", "description": "current_period_from", "format": "date-time" } }, { "name": "current_period_to", "in": "query", "description": "current_period_to", "required": true, "schema": { "type": "string", "description": "current_period_to", "format": "date-time" } }, { "name": "previous_period_from", "in": "query", "description": "previous_period_from", "required": true, "schema": { "type": "string", "description": "previous_period_from", "format": "date-time" } }, { "name": "previous_period_to", "in": "query", "description": "previous_period_to", "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", "description": "max_results", "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": "c9eba3b3-1beb-4250-9f75-ec301692bc3c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "current_period_from", "required": true, "schema": { "type": "string", "description": "current_period_from", "format": "date-time" } }, { "name": "current_period_to", "in": "query", "description": "current_period_to", "required": true, "schema": { "type": "string", "description": "current_period_to", "format": "date-time" } }, { "name": "previous_period_from", "in": "query", "description": "previous_period_from", "required": true, "schema": { "type": "string", "description": "previous_period_from", "format": "date-time" } }, { "name": "previous_period_to", "in": "query", "description": "previous_period_to", "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", "description": "max_results", "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": "d2262512-e32b-48a8-8a15-5b8acd9922ca" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "current_period_from", "required": true, "schema": { "type": "string", "description": "current_period_from", "format": "date-time" } }, { "name": "current_period_to", "in": "query", "description": "current_period_to", "required": true, "schema": { "type": "string", "description": "current_period_to", "format": "date-time" } }, { "name": "previous_period_from", "in": "query", "description": "previous_period_from", "required": true, "schema": { "type": "string", "description": "previous_period_from", "format": "date-time" } }, { "name": "previous_period_to", "in": "query", "description": "previous_period_to", "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", "description": "max_results", "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": "6bedde63-c71a-4840-b1a1-9edfd5c200b9" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "f1524ecd-621d-43d1-9d2a-b71904d54cb2" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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" }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendCodeByPhoneCredentialsServiceResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Content", "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": "cded7f45-db9d-49a9-94e5-88209e212570" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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", "description": "phone", "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": "3ffb9cbf-ee0d-4f34-a485-a3c6ec71461e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "61f79915-e1b1-4436-ac44-d71221b53422" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/auth/check-username-availability": { "post": { "tags": [ "Auth" ], "operationId": "CheckUsernameAvailability", "parameters": [ { "name": "username", "in": "query", "description": "username", "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": "847abf34-ef9c-4e29-b0f1-8c7bd6dd92e3" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "7c871108-f7c5-4f01-8d28-14fce2db8004" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "61940f2b-5bdd-40fa-a0f5-7f8227923a9d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "cf1d5c11-5771-443c-8b51-8d0756fd01a1" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "05fe61b5-0511-46b1-91b6-fa5d00dbce2c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRoleUserAccess" } } } }, "422": { "description": "Unprocessable Content", "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": "86e8d447-3416-4099-bc2e-a729e7f412d1" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAccess" } } } }, "422": { "description": "Unprocessable Content", "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": "14756d8d-6718-4c20-88d6-079181a51c71" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAccess" } } } }, "422": { "description": "Unprocessable Content", "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": "875a5d88-4858-471c-a792-d74cfcfa9baa" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "726745cf-af56-483f-9730-075e06ec712a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkplaceAccess" } } } }, "422": { "description": "Unprocessable Content", "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": "47c02a4c-100c-47b4-8260-f97b3157a1af" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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":"c17c9c0c-54c3-4bd2-aa25-8027e46c71e4","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":"c17c9c0c-54c3-4bd2-aa25-8027e46c71e4","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":"c17c9c0c-54c3-4bd2-aa25-8027e46c71e4","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":"c17c9c0c-54c3-4bd2-aa25-8027e46c71e4","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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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":"36d11b98-5c3d-4cfd-90f6-b3b619d1e712","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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "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": "669878a1-1f95-42e4-a4ab-ba368a302baa" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "84fde455-c39a-4579-a130-59daa14c09b9" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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":"e0f0668a-8c99-4a03-beb6-0942e33fea1d","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": "fe7f85ff-d3c2-4ac4-82a1-01ac4c7f0b55" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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": "e9f391bf-8e97-40ac-b396-b9dfbed31d88" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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": "1d9a9773-a90b-44da-94e4-92526eedb472" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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": "50a5570b-09ea-4bc3-807c-88973d698fee" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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", "description": "expand", "schema": { "type": "array", "items": { "type": "string" }, "description": "expand" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "2df46e74-b7e8-45b7-8479-fade65959750" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "OK", "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": "ecfe70f3-fc51-43d7-893c-a08c4a99ed45" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "919d71d7-48b0-41de-b8a4-5a477ac090f7" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "8f26882a-9982-4de8-8774-e4045ae2446c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "05d789ff-da27-4f12-a061-5eb5c87aa1ab" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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", "description": "expand", "schema": { "type": "array", "items": { "type": "string" }, "description": "expand" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "3c140797-4684-46ee-9248-01592ac352a0" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "OK", "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": "a9f6f376-5745-4310-8704-a0eb8cd99024" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "e51b2290-e521-4ce7-b683-9a97271c8e82" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "d7cef640-5f6b-4a24-b8f2-3703702f626a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "3a7367f6-4e6f-4d59-a7d6-a3ed701ddd03" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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":"92ba862a-47d2-4749-abcf-e4fb05306c42","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":"92ba862a-47d2-4749-abcf-e4fb05306c42","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":"92ba862a-47d2-4749-abcf-e4fb05306c42","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":"92ba862a-47d2-4749-abcf-e4fb05306c42","type_of":"Employee"} } } }, "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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":"e3d736a7-187d-480c-8c7e-3cfdfcef0f7d","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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "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": "35812c86-584a-4f0e-be0f-9483721f12d5" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "cff42e08-b5db-4183-9db7-3936b8d367bb" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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":"bfe7d563-58d0-4119-8cee-5d49cf715226","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": "37bc99f9-0173-41a0-9453-65aab0fd673b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "dbf3e676-3d13-4dd4-b5fb-8c45deeeb3a4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "72d3a272-466e-447b-b125-51173810f988" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "b72dead1-1076-4cc9-b78b-eaf4e1da4f1d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "826f6795-cac3-48ce-bdd3-d9eaed888ae6" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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/ResetPinCodeRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResetPinCodeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResetPinCodeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResetPinCodeRequest" } } } }, "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPinCodeResponse" } } } } }, "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": "bb78d22f-ebf7-45f9-b700-071b2083695c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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/ResetPasswordRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } } } }, "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "017bf972-f1ad-4259-ab58-ac7970449772" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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":"2134dbfa-78b7-4182-a03c-681dd556716e","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":"2134dbfa-78b7-4182-a03c-681dd556716e","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":"2134dbfa-78b7-4182-a03c-681dd556716e","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":"2134dbfa-78b7-4182-a03c-681dd556716e","type_of":"LegalEntity"} } } }, "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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":"e84b7853-4b05-4c8e-a954-778d5ea00a94","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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "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": "6f79d2cd-22e5-47ab-b70f-aa32575ee468" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "6326d931-2ffc-4662-9219-598dc3a026be" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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":"251b8d12-bfe0-47cd-b11f-9dd6c82cf6a3","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": "df818c44-26db-4d91-8f85-a7f0009adffc" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "bc91ab31-b618-4554-9c4d-db61a151ca61" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "aa98d081-d06d-4f1c-92ac-cce6e953b6ef" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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", "description": "date_from", "schema": { "type": "string", "description": "date_from", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "date_to", "schema": { "type": "string", "description": "date_to", "format": "date-time" } }, { "name": "page_token", "in": "query", "description": "page_token", "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": "1ccf60dd-bb8a-4bc2-93a2-343e8edb11d4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "date_from", "schema": { "type": "string", "description": "date_from", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "date_to", "schema": { "type": "string", "description": "date_to", "format": "date-time" } }, { "name": "page_token", "in": "query", "description": "page_token", "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": "c611bd14-e7c5-4f4e-8b2a-b2136dd611c0" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "date_from", "schema": { "type": "string", "description": "date_from", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "date_to", "schema": { "type": "string", "description": "date_to", "format": "date-time" } }, { "name": "page_token", "in": "query", "description": "page_token", "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": "55ee13b1-85a6-49ae-9c0e-a972e382aa42" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "date_from", "schema": { "type": "string", "description": "date_from", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "date_to", "schema": { "type": "string", "description": "date_to", "format": "date-time" } }, { "name": "page_token", "in": "query", "description": "page_token", "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": "dd354c64-523e-4726-9417-393ed0aa0bcc" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "date_from", "schema": { "type": "string", "description": "date_from", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "date_to", "schema": { "type": "string", "description": "date_to", "format": "date-time" } }, { "name": "page_token", "in": "query", "description": "page_token", "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": "99a5eb2d-eabc-437b-b5c2-f3f771986b0b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "date_from", "schema": { "type": "string", "description": "date_from", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "date_to", "schema": { "type": "string", "description": "date_to", "format": "date-time" } }, { "name": "outlet_guid", "in": "query", "description": "outlet_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "employee_guid", "in": "query", "description": "employee_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "employee_guid" } }, { "name": "page_token", "in": "query", "description": "page_token", "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": "35bc0263-b206-4877-952b-dd2e8bd1dc75" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "date_from", "schema": { "type": "string", "description": "date_from", "format": "date-time" } }, { "name": "good_category_guid", "in": "query", "description": "good_category_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "good_category_guid" } }, { "name": "outlet_guid", "in": "query", "description": "outlet_guid", "schema": { "type": "string", "description": "outlet_guid", "format": "uuid" } }, { "name": "warehouse_guid", "in": "query", "description": "warehouse_guid", "schema": { "type": "string", "description": "warehouse_guid", "format": "uuid" } }, { "name": "balance_type", "in": "query", "schema": { "$ref": "#/components/schemas/ReportNomenclatureBalanceType" } }, { "name": "balance_value", "in": "query", "description": "balance_value", "schema": { "type": "number", "description": "balance_value", "format": "double" } }, { "name": "page_token", "in": "query", "description": "page_token", "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": "415162c4-fc80-419f-9266-cd5bbdadf60e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "date_from", "schema": { "type": "string", "description": "date_from", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "date_to", "schema": { "type": "string", "description": "date_to", "format": "date-time" } }, { "name": "good_category_guid", "in": "query", "description": "good_category_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "good_category_guid" } }, { "name": "outlet_guid", "in": "query", "description": "outlet_guid", "schema": { "type": "string", "description": "outlet_guid", "format": "uuid" } }, { "name": "warehouse_guid", "in": "query", "description": "warehouse_guid", "schema": { "type": "string", "description": "warehouse_guid", "format": "uuid" } }, { "name": "page_token", "in": "query", "description": "page_token", "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": "1a961e71-dcf8-45e3-8708-52dfda7282f6" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "91c92039-6412-4046-bb8a-2b90b6493809" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "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": "66ee9c9d-8c59-4b2c-99d7-7fb6f7edfb67" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "a81a13e1-1048-4020-837f-329d9e0ceee0" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "208ffacc-0292-4a8f-8175-5aae98ed7c9f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "b843a81d-a626-4197-a528-b7c2bf51dc55" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "57675e6d-d68e-413d-acd0-bcdc80ab1a3e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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":"77589363-8752-4fe1-b08f-de3b4afbd00f","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":"77589363-8752-4fe1-b08f-de3b4afbd00f","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":"77589363-8752-4fe1-b08f-de3b4afbd00f","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":"77589363-8752-4fe1-b08f-de3b4afbd00f","type_of":"Organization"} } } }, "responses": { "500": { "description": "Internal 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":"48c5dd8d-7ee0-48a5-9138-51de6cf25f47","type_of":"Organization"} } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner" ] } ] }, "get": { "tags": [ "Organizations" ], "operationId": "ListOrganization", "parameters": [ { "name": "created_from", "in": "query", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "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": "cbdbaa7f-1d1f-4714-b04c-1743a1fca795" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationPage" } } } }, "422": { "description": "Unprocessable Content", "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": "b70be773-5b8a-4d32-8a00-928dcc036f9b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "OK", "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":"aa409197-e0b8-4ad9-b30d-776deff686c3","type_of":"Organization"} } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Content", "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": "a7bc81d3-0071-4491-9ccd-b4167fdc29aa" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "bf24a221-d3b6-479d-bcf7-97b09603b1df" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "866f5741-09bf-4a16-af3b-cb1413a659c8" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "2f35bfa9-2896-4ce6-b162-62fbf9a8a7e0" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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", "description": "processed_at_from", "schema": { "type": "string", "description": "processed_at_from", "format": "date-time" } }, { "name": "processed_at_to", "in": "query", "description": "processed_at_to", "schema": { "type": "string", "description": "processed_at_to", "format": "date-time" } }, { "name": "revenueByPeriodsType", "in": "query", "schema": { "$ref": "#/components/schemas/RevenueByPeriodsType" } }, { "name": "outlet_guid", "in": "query", "description": "outlet_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "employee_guid", "in": "query", "description": "employee_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "employee_guid" } }, { "name": "page_token", "in": "query", "description": "page_token", "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": "0df53fcc-c937-4dbe-90e5-cdf74359759e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "processed_at_from", "schema": { "type": "string", "description": "processed_at_from", "format": "date-time" } }, { "name": "processed_at_to", "in": "query", "description": "processed_at_to", "schema": { "type": "string", "description": "processed_at_to", "format": "date-time" } }, { "name": "revenueByPeriodsType", "in": "query", "schema": { "$ref": "#/components/schemas/RevenueByPeriodsType" } }, { "name": "outlet_guid", "in": "query", "description": "outlet_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "employee_guid", "in": "query", "description": "employee_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "employee_guid" } }, { "name": "page_token", "in": "query", "description": "page_token", "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": "b50ed6c8-09bf-47bc-bd57-5dd601eb9318" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "processed_at_from", "schema": { "type": "string", "description": "processed_at_from", "format": "date-time" } }, { "name": "processed_at_to", "in": "query", "description": "processed_at_to", "schema": { "type": "string", "description": "processed_at_to", "format": "date-time" } }, { "name": "revenueByPeriodsType", "in": "query", "schema": { "$ref": "#/components/schemas/RevenueByPeriodsType" } }, { "name": "outlet_guid", "in": "query", "description": "outlet_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "employee_guid", "in": "query", "description": "employee_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "employee_guid" } }, { "name": "page_token", "in": "query", "description": "page_token", "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": "2a6733d3-1aad-40d9-b2ed-51503a7d936f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "processed_at_from", "schema": { "type": "string", "description": "processed_at_from", "format": "date-time" } }, { "name": "processed_at_to", "in": "query", "description": "processed_at_to", "schema": { "type": "string", "description": "processed_at_to", "format": "date-time" } }, { "name": "revenueByPeriodsType", "in": "query", "schema": { "$ref": "#/components/schemas/RevenueByPeriodsType" } }, { "name": "outlet_guid", "in": "query", "description": "outlet_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "employee_guid", "in": "query", "description": "employee_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "employee_guid" } }, { "name": "page_token", "in": "query", "description": "page_token", "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": "75e13455-3a0d-4bb7-bec2-dfc25072d628" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "processed_at_from", "schema": { "type": "string", "description": "processed_at_from", "format": "date-time" } }, { "name": "processed_at_to", "in": "query", "description": "processed_at_to", "schema": { "type": "string", "description": "processed_at_to", "format": "date-time" } }, { "name": "revenueByPeriodsType", "in": "query", "schema": { "$ref": "#/components/schemas/RevenueByPeriodsType" } }, { "name": "outlet_guid", "in": "query", "description": "outlet_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "employee_guid", "in": "query", "description": "employee_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "employee_guid" } }, { "name": "page_token", "in": "query", "description": "page_token", "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": "1bd760ab-a421-4e89-bfc9-50734e938372" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "processed_at_from", "schema": { "type": "string", "description": "processed_at_from", "format": "date-time" } }, { "name": "processed_at_to", "in": "query", "description": "processed_at_to", "schema": { "type": "string", "description": "processed_at_to", "format": "date-time" } }, { "name": "outlet_guid", "in": "query", "description": "outlet_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "page_token", "in": "query", "description": "page_token", "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": "f2586c6a-66a3-4929-8d95-0c5edf22ac28" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "processed_at_from", "schema": { "type": "string", "description": "processed_at_from", "format": "date-time" } }, { "name": "processed_at_to", "in": "query", "description": "processed_at_to", "schema": { "type": "string", "description": "processed_at_to", "format": "date-time" } }, { "name": "employee_guid", "in": "query", "description": "employee_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "employee_guid" } }, { "name": "page_token", "in": "query", "description": "page_token", "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": "207a8ed4-1ead-4dfe-a771-3ad14cbd4de9" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "8cf52c77-b060-434b-97fb-fc85fd8c076f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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", "description": "expand", "schema": { "type": "array", "items": { "type": "string" }, "description": "expand" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "1e10a219-f273-40a9-b883-0f142303b7e5" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "OK", "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": "e28c20e7-5c80-400c-9160-7af137219c81" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "ef9f5df4-717c-490d-8542-195f7dfed8aa" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "59995136-0e96-4a7e-b8b7-153b0d2c0d94" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "c58e7513-789e-4984-b4fa-793b21dd16fd" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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", "description": "expand", "schema": { "type": "array", "items": { "type": "string" }, "description": "expand" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "b516bcaf-f57a-4c18-8523-c673675c084c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "OK", "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": "393de4ba-bdcd-4052-9b9c-032e7ab6fc29" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "694c47b5-08c6-42d4-9e20-3aec9909dd38" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "609d384d-1fad-4874-aa9b-3bb8ca295cbb" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "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": "0842abec-2934-43c0-8b6d-160f366ddaf6" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "f4f8fad8-a63e-44af-89e5-0783f2404404" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "page_token", "in": "query", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "expand", "in": "query", "description": "expand", "schema": { "type": "array", "items": { "type": "string" }, "description": "expand" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/DefaultOrderings" } }, { "name": "query", "in": "query", "description": "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", "description": "include_items_total", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "total_amount_from", "in": "query", "description": "total_amount_from", "schema": { "type": "integer", "description": "total_amount_from", "format": "int64" } }, { "name": "total_amount_to", "in": "query", "description": "total_amount_to", "schema": { "type": "integer", "description": "total_amount_to", "format": "int64" } }, { "name": "total_quantity_from", "in": "query", "description": "total_quantity_from", "schema": { "type": "number", "description": "total_quantity_from", "format": "double" } }, { "name": "total_quantity_to", "in": "query", "description": "total_quantity_to", "schema": { "type": "number", "description": "total_quantity_to", "format": "double" } }, { "name": "type", "in": "query", "description": "type", "schema": { "pattern": "(DirectSaleSession|DirectCorrectionSaleSession|ReversalSaleSession|ReversalCorrectionSaleSession)", "type": "string", "description": "type" } }, { "name": "outlet_guid", "in": "query", "description": "outlet_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "workplace_guid", "in": "query", "description": "workplace_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "workplace_guid" } }, { "name": "opened_by_guid", "in": "query", "description": "opened_by_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "opened_by_guid" } }, { "name": "transaction_guid", "in": "query", "description": "transaction_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "transaction_guid" } }, { "name": "fiscal_document_guid", "in": "query", "description": "fiscal_document_guid", "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": "c4fcc06a-11d8-4543-b1b5-20e34cfb474c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "OK", "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": "657d52ad-17be-4c3b-b097-f105082976a1" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "OK", "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": "37498196-3c49-406b-89bc-d8036402bcfe" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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":"1c27a1f7-9bcd-44aa-a8a6-5cf9d95e5b01","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":"1c27a1f7-9bcd-44aa-a8a6-5cf9d95e5b01","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":"1c27a1f7-9bcd-44aa-a8a6-5cf9d95e5b01","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":"1c27a1f7-9bcd-44aa-a8a6-5cf9d95e5b01","type_of":"Uom"} } } }, "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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":"a8d4f639-0028-4276-b14f-fbd16f26db5f","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": "d4501176-3361-4c9a-98cb-861b22cc16ad" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "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": "762946c9-35a8-401f-9976-e5db2c06ab37" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "c4f07a0e-d75a-4965-a0c5-ed376a78dcba" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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":"0085ca39-94c7-4c1b-a767-1dc19fd0f843","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": "7996cc88-950a-44f4-aa95-412503af9b14" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "5605bc6a-ea8f-4220-8076-90e6499cfcd4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "2514ca15-bb6e-41b2-b134-84581839a3ad" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "d6a27843-1f72-4ed9-b210-10d0386d7797" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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":"fa41fd73-eb38-4c1a-be33-52f67e80ea2a","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":"fa41fd73-eb38-4c1a-be33-52f67e80ea2a","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":"fa41fd73-eb38-4c1a-be33-52f67e80ea2a","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":"fa41fd73-eb38-4c1a-be33-52f67e80ea2a","type_of":"Workplace"} } } }, "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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":"fe2d8520-004e-4369-99ed-35c29cbab21e","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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "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": "5093e868-4b66-4617-9670-693f8e21d4f2" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkplacePage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/workplaces:check-number-availability": { "post": { "tags": [ "Workplaces" ], "operationId": "CheckWorkplaceNumberAvailability", "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": "b01cb168-7451-4c18-92f3-5990de85d1a7" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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/CheckWorkplaceNumberAvailabilityParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CheckWorkplaceNumberAvailabilityParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CheckWorkplaceNumberAvailabilityParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CheckWorkplaceNumberAvailabilityParams" } } } }, "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "204": { "description": "No Content" } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator" ] } ] } }, "/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": "d4e17f4c-9402-46ff-a23a-7be67fe9cf34" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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":"12c64bda-8813-4197-911f-803ef9f91ed0","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": "eb248927-470c-4f9e-8a4f-407a7d2d13a8" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "a2e7d615-6662-4fa8-b85c-641e2026a86e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "bd517143-afc6-47db-8b3e-7cced788dc1a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "abc777eb-8687-4a62-aad2-61e5e9286b18" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "2077b080-7dd4-4a0a-b12f-43cca1ec6e24" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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": "90d2df62-3ee9-48a7-9582-9bc4668d3c80" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/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": "22a20ad8-ff4d-44d3-92de-d926b5d399f3" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/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": "01578ab4-90da-4058-b7ed-ff1415f95410" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "18c56f4d-9ab1-46b6-900c-7410e3e13342" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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": "a28ab587-9355-44ff-b326-34d775de7942" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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": "921f6a52-cbc9-4796-a68b-2ff81bacd9c5" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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":"dee79464-b2af-468d-8519-05e22560b28d","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":"dee79464-b2af-468d-8519-05e22560b28d","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":"dee79464-b2af-468d-8519-05e22560b28d","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":"dee79464-b2af-468d-8519-05e22560b28d","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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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":"18a0697a-fec5-45ff-8381-07c6c5835410","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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "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": "3a2a9891-5268-4026-8a55-6accac242241" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "ae7a3057-ef2f-4c54-9e10-88d850955ca4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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":"8acc0be3-a7cf-4f1b-99a5-abc2beee6964","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": "f6316b61-1eee-4526-b0de-c3fbe974e050" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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": "c473c116-ce93-4caf-9a4a-81311237371d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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": "7b7a8c92-53cd-400c-b181-b192f03beb35" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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": "b4ec050f-e353-4caa-8238-58cdcf1ecb43" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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":"ad69798a-fea9-4552-8182-8dec51b96c3a","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":"ad69798a-fea9-4552-8182-8dec51b96c3a","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":"ad69798a-fea9-4552-8182-8dec51b96c3a","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":"ad69798a-fea9-4552-8182-8dec51b96c3a","type_of":"GoodsCategory"} } } }, "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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":"84e2eb2d-5ccc-4fe0-aae0-cfd3f47f35c2","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": "b409abcb-5aca-4961-be14-96056d25e5a4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "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": "0c06c4c3-4ef4-46c6-83f5-f2f1737e9825" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "716a37f1-2edd-4012-8397-61491e8eac9a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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":"c5ca07a2-d7aa-4011-bbdd-eeba106b11a0","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": "27509492-5440-4303-ae62-21f9c5169420" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "c3b3a0b0-5977-4c3f-a09c-c4897dc7ff1e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "89df5a01-6e57-4836-8401-28c9c79b1105" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "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": "d9738f1b-d04d-4935-ba43-fc12dd83959e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "0c493a45-7a7d-4957-9c45-ca0b013fcd5f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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":"0011408f-f568-4d73-bb50-88213fae00e6","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":"59926a3e-bd9c-4ff8-a851-8783d1275801","type_of":"GoodsCategory"},"is_serial":true,"is_markable":true,"is_part_of_package_of":7,"organization":{"guid":"cfe2c139-1a44-4a79-8eb9-f11149391002","type_of":"Organization"},"product_group":"tobacco","is_package_of":20,"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":"a78f29ad-52aa-40bc-85a4-1fb694267a04","type_of":"Good"} }, "application/json": { "schema": { "$ref": "#/components/schemas/Good" }, "example": {"settlement_subject":"Product","name":"Наименование товара","uom":{"guid":"0011408f-f568-4d73-bb50-88213fae00e6","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":"59926a3e-bd9c-4ff8-a851-8783d1275801","type_of":"GoodsCategory"},"is_serial":true,"is_markable":true,"is_part_of_package_of":7,"organization":{"guid":"cfe2c139-1a44-4a79-8eb9-f11149391002","type_of":"Organization"},"product_group":"tobacco","is_package_of":20,"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":"a78f29ad-52aa-40bc-85a4-1fb694267a04","type_of":"Good"} }, "text/json": { "schema": { "$ref": "#/components/schemas/Good" }, "example": {"settlement_subject":"Product","name":"Наименование товара","uom":{"guid":"0011408f-f568-4d73-bb50-88213fae00e6","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":"59926a3e-bd9c-4ff8-a851-8783d1275801","type_of":"GoodsCategory"},"is_serial":true,"is_markable":true,"is_part_of_package_of":7,"organization":{"guid":"cfe2c139-1a44-4a79-8eb9-f11149391002","type_of":"Organization"},"product_group":"tobacco","is_package_of":20,"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":"a78f29ad-52aa-40bc-85a4-1fb694267a04","type_of":"Good"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Good" }, "example": {"settlement_subject":"Product","name":"Наименование товара","uom":{"guid":"0011408f-f568-4d73-bb50-88213fae00e6","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":"59926a3e-bd9c-4ff8-a851-8783d1275801","type_of":"GoodsCategory"},"is_serial":true,"is_markable":true,"is_part_of_package_of":7,"organization":{"guid":"cfe2c139-1a44-4a79-8eb9-f11149391002","type_of":"Organization"},"product_group":"tobacco","is_package_of":20,"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":"a78f29ad-52aa-40bc-85a4-1fb694267a04","type_of":"Good"} } } }, "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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":"4aaf773a-67df-4a25-a47a-37b49ed94805","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":"6df0e912-337f-4933-9438-c69014f77036","type_of":"GoodsCategory"},"is_serial":true,"is_markable":true,"is_part_of_package_of":7,"organization":{"guid":"1df10c77-6772-417c-bda8-277f163322a2","type_of":"Organization"},"product_group":"tobacco","is_package_of":20,"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":"ec9f0216-1daf-407b-80d2-80fa3f8eb1de","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": "62926f6f-9bbb-4092-8ecb-e1c3918e43a3" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "barcode_contains", "in": "query", "description": "barcode_contains", "schema": { "type": "string", "description": "barcode_contains" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "8296838f-3a76-4c21-ae03-ef920887274e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "6a244069-c724-41f9-b866-d36f778aad24" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "23969276-d907-4862-9c6f-278135c93bb1" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Good" }, "example": {"settlement_subject":"Product","name":"Наименование товара","uom":{"guid":"0656d8e7-da08-490d-ba35-437ad4193a4e","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":"e0015f1d-5838-400e-9a74-1fae7c7754d8","type_of":"GoodsCategory"},"is_serial":true,"is_markable":true,"is_part_of_package_of":7,"organization":{"guid":"6f62662f-fc86-49e6-84d2-d1d585d56679","type_of":"Organization"},"product_group":"tobacco","is_package_of":20,"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":"9637e7aa-f61b-462d-8f18-78b04f375e7d","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": "4d71ab5e-e1be-4950-88fc-95097b22afe1" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "84b4105a-788a-422b-939b-c0c283302847" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "4fc3aea0-1c55-4fd5-bad7-6e774b7e76cb" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "7e13757c-4ece-43e2-9ecb-fb7549f2efde" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "c389b2a1-c103-4be6-8bc9-d9a53af02372" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "c4e78cc1-f2e8-44d3-ae74-27d1c8300c8a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "8b091225-86ec-4d31-bc7f-d5413b20612a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "56362b5c-98cd-47b0-bfe4-62f19dc37682" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "a6a7b1db-e32b-498f-afd3-fc874b3adc90" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "abbd3e4d-4d50-4d82-94f3-d3f619d4bdd3" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "e614b6bb-2836-4f0c-b24f-6d358d55c485" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "b0682b7d-eed7-4353-aac4-918ec501a4e4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "3f4d4ba2-7e71-4e7e-b85b-86bb2da54336" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "5d4e7df8-88e7-4f45-8600-f34ef745b5c8" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "a574d87a-9eb3-4e35-9398-23bd4cd5ae95" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "237fc600-4128-4201-9d9f-6d4717cb83d4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "f6b37d59-a00d-4df9-93d1-008b3cdb1b44" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "1b31d5b7-e7af-4d2c-81b6-c0ac8766891e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "32094cb1-f9f7-4fd0-a490-bfb4922dd012" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "3e9064a3-c8c8-4312-9828-6dcaada9f883" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "a5f3ea15-eb33-4fd1-b202-6f13b3b800a8" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "6d305def-5504-4c66-a31e-2ed026676aed" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "9111a2ee-dd68-4e50-b057-7e221b27f211" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "dd3c7faa-65b8-44c3-9081-fae747efbac7" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "c9c83fe4-ba03-44f7-afef-08767c673528" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "017bd995-2057-46cd-a260-006b2625411b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "7ebdd32f-6719-4caf-93ef-9cced4ec5139" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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", "description": "guid", "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": "0e31d1ca-49a0-424a-a3a4-4b0b9e502e81" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "2eb34993-3598-4fb5-8b99-a0eff5983176" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "6a4a5273-f28e-463b-bca5-9b7b81cf8c23" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "2836af2b-1dbd-43b4-9617-99542fd322bc" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "c06b8b29-c677-4b52-adcd-34955526a37a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "5c17a22a-30c1-4348-96b6-37cf1cbff516" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "79df8c5c-c42c-4bbe-9aee-ac80ff03503a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "6a55770c-2cb3-4b21-96c6-4617022766c2" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "ba84aa4e-241f-480d-a057-1a4d389eb794" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "ec5f76aa-9c45-48fb-8a5f-4368010842af" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "3479bc69-f10a-493b-a5bd-79f7d31eb0e4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "d7d42d2b-04be-4952-8983-df1f95dbed8f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "dfbc94b4-efda-4cd8-93bb-98d2abfb0325" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "93406b49-f4f3-4738-85c3-f6ef5b6e8f03" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "70bc72d6-ad06-47e2-a247-35b54f38350f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "2d6dc9ae-d0c6-4d3c-8d7f-db928dd8676f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "3da94096-30f6-4275-b8b5-95c03a833d7e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "e6655afa-4819-4b51-87c2-2ff972019f4e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "0de31190-7868-4c9a-a501-e3c1dc2731e4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "b001742b-ea31-40fb-8d9d-fb629789768c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "6bfbcc94-f211-438b-b7e8-a394eafee339" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "ca71c562-5e97-409a-be68-7e09b70c0265" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "e6d939b1-238b-41b4-a7ab-17414db01b7e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "a974d019-9617-4762-9c37-f4eb5a3aea12" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "85a0e043-3626-483e-bb16-dd8453ba67a0" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "10b37083-c35d-4b18-a00a-10aeb1bdc436" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "67b2eb50-9877-4b7b-a4fb-3f40e305ab94" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "b87faef4-a337-4e2f-9f81-0fd5801d4e70" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "0df71d34-0875-4eb4-8056-ea1624d05db4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "3d267419-c6aa-4093-86fd-1ae18549177f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "4f8361ae-3c2e-430f-8a81-664f4c117693" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "9f24c65e-86dd-488b-b5ec-7c1ea233d529" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "fiscal_form", "in": "query", "description": "fiscal_form", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "description": "fiscal_form" } }, { "name": "number", "in": "query", "description": "number", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "number" } }, { "name": "issued_at_from", "in": "query", "description": "issued_at_from", "schema": { "type": "string", "description": "issued_at_from", "format": "date-time" } }, { "name": "issued_at_to", "in": "query", "description": "issued_at_to", "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": "7effab30-a5d2-476f-94d7-6ae1de14b203" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "bd0e7079-74b4-48c6-8d5f-e8bffb3913da" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "fiscal_form", "in": "query", "description": "fiscal_form", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FiscalDocumentForms" }, "description": "fiscal_form" } }, { "name": "number", "in": "query", "description": "number", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "number" } }, { "name": "issued_at_from", "in": "query", "description": "issued_at_from", "schema": { "type": "string", "description": "issued_at_from", "format": "date-time" } }, { "name": "issued_at_to", "in": "query", "description": "issued_at_to", "schema": { "type": "string", "description": "issued_at_to", "format": "date-time" } }, { "name": "fiscal_status", "in": "query", "description": "fiscal_status", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FiscalStatus" }, "description": "fiscal_status" } }, { "name": "source_type", "in": "query", "description": "source_type", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/SourceType" }, "description": "source_type" } }, { "name": "outlet_guid", "in": "query", "description": "outlet_guid", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "legal_entity_guid", "in": "query", "description": "legal_entity_guid", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "legal_entity_guid" } }, { "name": "employee_guid", "in": "query", "description": "employee_guid", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "employee_guid" } }, { "name": "position_names", "in": "query", "description": "position_names", "schema": { "type": "string", "description": "position_names" } }, { "name": "registrar_serial_number", "in": "query", "description": "registrar_serial_number", "schema": { "type": "string", "description": "registrar_serial_number" } }, { "name": "shift_number", "in": "query", "description": "shift_number", "schema": { "type": "integer", "description": "shift_number", "format": "int32" } }, { "name": "payment_types", "in": "query", "description": "payment_types", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FiscalPaymentTypes" }, "description": "payment_types" } }, { "name": "format", "in": "query", "description": "format", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "format" } }, { "name": "total_sum_from", "in": "query", "description": "total_sum_from", "schema": { "type": "integer", "description": "total_sum_from", "format": "int64" } }, { "name": "total_sum_to", "in": "query", "description": "total_sum_to", "schema": { "type": "integer", "description": "total_sum_to", "format": "int64" } }, { "name": "fiscal_document_guid", "in": "query", "description": "fiscal_document_guid", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "fiscal_document_guid" } }, { "name": "sale_session_type", "in": "query", "description": "sale_session_type", "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": "a97f1584-c5cb-4663-bf76-ae6c648f96e4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "2ec3b87f-a9d1-43d5-976e-700ef8ef4872" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "c893c8f5-75fa-4bed-a127-32a6aec577d0" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "guid", "in": "query", "description": "guid", "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": "ea6835db-ac85-48b9-9ec1-c7efaf64d0c2" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "3297ffb8-384a-4f31-8791-809eaba9b52c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "0c533617-2fc3-462f-b07a-a9ccf2044b00" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "b38d9aaa-80c3-4dae-a5ab-cdd1a8a50be7" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "0c64a75b-bd98-4657-aea3-4c3c3071e08c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "ed467ca7-5942-4de9-974c-10a258afa0a4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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-10-07T03:26:29.0126204Z","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":"5ffbba61-e46f-42c2-8368-643f04e5d1c3","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-10-07T03:26:29.0126204Z","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":"5ffbba61-e46f-42c2-8368-643f04e5d1c3","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-10-07T03:26:29.0126204Z","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":"5ffbba61-e46f-42c2-8368-643f04e5d1c3","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-10-07T03:26:29.0126204Z","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":"5ffbba61-e46f-42c2-8368-643f04e5d1c3","type_of":"Sale"} } } }, "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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-10-07T03:26:29.0135443Z","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":"d86c0814-c112-42e9-9805-afdae03bed0d","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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "page_token", "in": "query", "description": "page_token", "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", "description": "include_items_total", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "opened_at_from", "in": "query", "description": "opened_at_from", "schema": { "type": "string", "description": "opened_at_from", "format": "date-time" } }, { "name": "opened_at_to", "in": "query", "description": "opened_at_to", "schema": { "type": "string", "description": "opened_at_to", "format": "date-time" } }, { "name": "total_sum_from", "in": "query", "description": "total_sum_from", "schema": { "type": "integer", "description": "total_sum_from", "format": "int64" } }, { "name": "total_sum_to", "in": "query", "description": "total_sum_to", "schema": { "type": "integer", "description": "total_sum_to", "format": "int64" } }, { "name": "states", "in": "query", "description": "states", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealStates" }, "description": "states" } }, { "name": "payment_statuses", "in": "query", "description": "payment_statuses", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealPaymentStatus" }, "description": "payment_statuses" } }, { "name": "shipping_statuses", "in": "query", "description": "shipping_statuses", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealShippingStatus" }, "description": "shipping_statuses" } }, { "name": "outlet_guid", "in": "query", "description": "outlet_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "outlet_guid" } }, { "name": "opened_by_guid", "in": "query", "description": "opened_by_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "opened_by_guid" } }, { "name": "workplace_guid", "in": "query", "description": "workplace_guid", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "workplace_guid" } }, { "name": "comment_contains", "in": "query", "description": "comment_contains", "schema": { "type": "string", "description": "comment_contains" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "bd1b7167-d284-4480-a082-fbba6368736d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "OK", "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": "2e374cb3-f444-4595-9ea1-eddcedb22360" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "4f02a576-6658-413a-ab71-cf95f6a18576" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "OK", "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-10-07T03:26:29.0201627Z","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":"158b354d-e8ce-4a47-83db-8a2e0b404aed","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": "8968ea14-aa43-40a2-b7c8-f37ef4a2033d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "3a1114c5-276b-42aa-9969-3d9d4d1b33ab" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "d257810d-e3c1-418b-b2e7-d8f146fa0382" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "created_from", "in": "query", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/AsyncTaskOrdering" } }, { "name": "task_status", "in": "query", "description": "task_status", "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", "description": "include_items_total", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "c7c84403-853e-4584-a167-0e7ed073c04e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IAsyncTaskPage" } } } }, "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/imports/employees": { "get": { "tags": [ "EmployeeImport" ], "operationId": "ListEmployeeImportTask", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page_token", "in": "query", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "created_from", "in": "query", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/AsyncTaskOrdering" } }, { "name": "task_status", "in": "query", "description": "task_status", "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", "description": "include_items_total", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "59448490-4a2f-49f7-bdc6-f1112859a031" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeImportTaskPage" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/imports/employees/template.xlsx": { "get": { "tags": [ "EmployeeImport" ], "operationId": "GetEmployeeImportTaskTemplateFile", "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": "f2e848be-628a-4657-bb7b-cd016897c2b8" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "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": "Internal Server Error", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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/employees:new.xlsx": { "post": { "tags": [ "EmployeeImport" ], "operationId": "CreateEmployeeImportTask", "parameters": [ { "name": "org_guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "params", "in": "query", "schema": { "$ref": "#/components/schemas/EmployeeImportFromExcelParams" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "e2d340a2-88b2-413d-a475-9ee086f270dd" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeImportTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/imports/employees/{task_guid}": { "get": { "tags": [ "EmployeeImport" ], "operationId": "GetEmployeeImportTaskById", "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": "d21220fe-0044-47b1-ade3-c2cc09fd7d60" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncTask" } } } } }, "security": [ { "Bearer": [ ], "OAuth2": [ "owner", "administrator", "manager" ] } ] } }, "/orgs/{org_guid}/async/imports/employees/{task_guid}/source.xlsx": { "get": { "tags": [ "EmployeeImport" ], "operationId": "GetEmployeeImportTaskSourceFile", "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": "447d1a63-b97a-486e-bd4d-b06e3f693f20" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "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": "Internal Server Error", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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/employees/{task_guid}:confirm": { "post": { "tags": [ "EmployeeImport" ], "operationId": "ConfirmEmployeeImportTask", "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": "99afca81-51cd-43fe-81aa-d1af2f68a5b3" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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/employees/{task_guid}:cancel": { "post": { "tags": [ "EmployeeImport" ], "operationId": "CancelEmployeeImportTask", "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": "f13e55f2-623f-400b-9507-5f6676ef005c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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/employees/*:cancel": { "post": { "tags": [ "EmployeeImport" ], "operationId": "CancelAllEmployeeImportTask", "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": "482de507-bb7c-46cc-98ba-e68dc8822b79" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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/employees/{task_guid}/previews/employees": { "get": { "tags": [ "EmployeeImportTaskPreview" ], "operationId": "GetImportPreviewItemEmployee", "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", "description": "page_token", "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": "8fa3d390-21e5-476d-9203-3cd07124d802" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeImportPreviewItemPage" } } } } }, "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "created_from", "in": "query", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/AsyncTaskOrdering" } }, { "name": "task_status", "in": "query", "description": "task_status", "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", "description": "include_items_total", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "2fb65403-9e13-462d-acf8-001e2a92e659" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "created_from", "in": "query", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/AsyncTaskOrdering" } }, { "name": "task_status", "in": "query", "description": "task_status", "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", "description": "include_items_total", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "0ff815ec-a40e-40dd-b666-bce8c5bc0add" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "created_from", "in": "query", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/AsyncTaskOrdering" } }, { "name": "task_status", "in": "query", "description": "task_status", "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", "description": "include_items_total", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "d242d21d-3ccc-42b6-9c87-fc56b3e6f427" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "7d3d7a8b-ac18-4fdc-9321-d179ca293218" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "dacebead-8b32-442c-bd29-b90038ec16a0" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "67a86e65-857e-4270-b711-59637a066b5b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "4edc2f4f-b406-45b4-9a76-3f66227c02ff" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "created_from", "in": "query", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/AsyncTaskOrdering" } }, { "name": "task_status", "in": "query", "description": "task_status", "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", "description": "include_items_total", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "48d60adc-8010-4362-b4af-1eddf5a25dd5" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "c05d777a-0b29-47b0-b6b3-de918422bc18" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "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": "Internal Server Error", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "0763208b-67f6-41db-8179-e8fb43178241" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "6bcd64a7-0e8a-41a7-9c4c-2256db763419" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "f7690dd2-3020-487b-b53b-0c7c5739fc00" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "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": "Internal Server Error", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "2f17e7dc-767d-4fc5-b2bc-50a28000ad14" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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": "8c0a21bb-415e-4e9f-ac86-f335999bb87e" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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": "ce0f5c90-93b9-4399-bee7-861d566a4a2b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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", "description": "page_token", "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": "61565a27-1149-4a62-9af4-bd9c631f1d88" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "page_token", "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": "53bcd492-42ac-4edf-a7a6-65ef0fca7178" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "page_token", "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": "60fe23d6-81a2-4e60-88e3-cd182097955f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "created_from", "in": "query", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "schema": { "type": "string", "description": "updated_to", "format": "date-time" } }, { "name": "order_by", "in": "query", "schema": { "$ref": "#/components/schemas/AsyncTaskOrdering" } }, { "name": "task_status", "in": "query", "description": "task_status", "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", "description": "include_items_total", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "bbec55da-9713-4a0a-b10d-f44109746547" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "d3e1757f-318b-4499-ad6e-14799eb64b49" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "e8f85daf-f758-49f0-aaae-1b0f90ffd883" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "6444fc8c-1297-419c-9bf3-ec14ca6febc4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "f5e4db4d-a9e2-4ce5-8340-3ee4ea392f2a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "3c6fead7-7f5e-4359-b49f-a7b0d7e9b485" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "40d2d824-c0c3-4af5-80fb-605cf73cf9bb" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "1f57b001-08d5-482a-aadb-91df1f3a6368" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "68b161f5-b651-4c41-9342-e255dda80183" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "878d3262-d27b-4d90-a51e-e3d679f71364" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "a648ff4a-febc-4ca8-91fe-ee9d32a97961" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "95d1155f-bfc4-4a1a-bf91-c95f250e2303" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "c45db257-cad5-478e-bc94-da86036807b5" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "f6ba6158-dbac-4094-a891-a9d4d14c7776" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "0328edd1-a6b9-4859-861c-f6bfb5a21bf7" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "a37a73ab-e897-43be-a2f8-06a3424ee1cd" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "3cf75e28-2042-4c1c-9340-f984703233d6" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "42788aed-7cdb-4233-8155-d6f31db034fc" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "cb22f237-f8cd-4af1-8896-67b2a1c2faec" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "8fb116e6-c48d-4b56-9d40-dfe04c7af781" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "8cd623eb-5b18-45f9-8254-c737cba0fdd3" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "da9ca15b-8af6-4ae3-a537-7b83cdb47dc9" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "c59f23d9-a7d5-4b8d-8f80-02405d4759a0" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "created_from", "in": "query", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "include_items_total", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "task_status", "in": "query", "description": "task_status", "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": "ab1f1982-8141-45d3-812f-bc99ba52c0c2" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "c2fa1b1d-5619-4a31-9a83-79ec73c16917" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "7fb67a66-50f9-4279-ace3-4251fb76177d" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "81d1f9b9-2fc2-4a9e-858b-63b505eb4fa3" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "3b5339e1-b354-4372-8f09-6eec6557c537" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "9d68bd16-6d54-47ac-84c1-60398518d3c1" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "ad587ed4-eb76-4235-8ac0-b5e52cf87f42" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "edc51fc3-e4cd-4586-9f9c-76bf495e9d26" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "248f7751-0b5f-4b6a-baea-dccabb64930c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "2bbaf69f-ba90-44bc-a7a8-d546e3768e70" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "cdcca665-a13f-4867-bb6a-2d94ab568f80" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal 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": "5ca73005-4e84-4129-925d-a430830e6df2" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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":"bdb16613-e4e8-4498-acd0-e6985a9da08b"} }, "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":"bdb16613-e4e8-4498-acd0-e6985a9da08b"} }, "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":"bdb16613-e4e8-4498-acd0-e6985a9da08b"} }, "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":"bdb16613-e4e8-4498-acd0-e6985a9da08b"} } } }, "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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":"2aff3a8a-b1ee-4b02-95d5-ebe74c728639"} } } } }, "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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "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": "f969bb96-fb3b-4c76-b393-4aa06e207957" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "888ba63a-ee7a-4a6c-94a2-13bd04e208b7" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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":"dcd557f9-ea6c-43b2-84b1-1f3275b7ab0c"} } } } }, "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": "93d5f935-2115-4edc-a326-42739df97fc9" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "19ebfb9e-873a-432c-af80-a17da2e67829" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "b41f77a8-e31a-4498-99f8-f33e10174542" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "6ac57dc3-14d4-4b2e-9eb7-23772cda2c7f" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "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": "c949dfcc-ba5f-438a-aece-eb1ef89260c4" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "34430ea0-bf29-4a71-83b9-349dcdbc18a8" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "fdd37275-e1aa-4cf9-a9a5-3a5d514dc7ac" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "03b688f8-b11d-4b3c-b663-6915ff3a4bbc" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "b304aad7-82af-4d10-b0e6-224c9ed2c47a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "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": "44bd1ff8-9594-4866-b215-74fb408ca28b" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "57198a18-ebc5-4d46-963f-a3314d7dec0a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "f74708a5-35f9-461c-b57a-d89a5b782ae0" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "operation", "in": "query", "description": "operation", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TransactionOperationTypes" }, "description": "operation" } }, { "name": "registered_at_from", "in": "query", "description": "registered_at_from", "schema": { "type": "string", "description": "registered_at_from", "format": "date-time" } }, { "name": "registered_at_to", "in": "query", "description": "registered_at_to", "schema": { "type": "string", "description": "registered_at_to", "format": "date-time" } }, { "name": "amount_from", "in": "query", "description": "amount_from", "schema": { "type": "integer", "description": "amount_from", "format": "int64" } }, { "name": "amount_to", "in": "query", "description": "amount_to", "schema": { "type": "integer", "description": "amount_to", "format": "int64" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "020b340b-dc08-449c-888d-400a6d31dd24" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "fe3f861e-7f16-4fc1-bd3e-198d2f1c5b6c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "4e6d0a24-4af2-4c9a-b1c7-63f0237ab3fd" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "bede12cc-6b7c-4054-a3cc-0c51406de2c5" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "ee72b57a-de14-4d8e-aaf7-126547d6420c" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "4e7002cc-8871-4078-a666-72e227349cee" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "operation", "in": "query", "description": "operation", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TransactionOperationTypes" }, "description": "operation" } }, { "name": "registered_at_from", "in": "query", "description": "registered_at_from", "schema": { "type": "string", "description": "registered_at_from", "format": "date-time" } }, { "name": "registered_at_to", "in": "query", "description": "registered_at_to", "schema": { "type": "string", "description": "registered_at_to", "format": "date-time" } }, { "name": "amount_from", "in": "query", "description": "amount_from", "schema": { "type": "integer", "description": "amount_from", "format": "int64" } }, { "name": "amount_to", "in": "query", "description": "amount_to", "schema": { "type": "integer", "description": "amount_to", "format": "int64" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "d0234371-26bf-454c-9d2a-7d85585ef926" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "fd091cec-b655-4d65-a41d-ab1d442134d3" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "0aee83db-4a32-4cea-b8ea-634f93ebd8bf" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "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": "Internal 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": "Unprocessable Content", "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": "36e34a56-f616-4e22-8ac4-259e0e1922e5" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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": "c5cb603d-5082-467b-a391-7ac285182f07" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "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", "description": "created_from", "schema": { "type": "string", "description": "created_from", "format": "date-time" } }, { "name": "created_to", "in": "query", "description": "created_to", "schema": { "type": "string", "description": "created_to", "format": "date-time" } }, { "name": "updated_from", "in": "query", "description": "updated_from", "schema": { "type": "string", "description": "updated_from", "format": "date-time" } }, { "name": "updated_to", "in": "query", "description": "updated_to", "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", "description": "page_token", "schema": { "type": "string", "description": "page_token" } }, { "name": "selection", "in": "query", "schema": { "$ref": "#/components/schemas/SelectionModes" } }, { "name": "include_items_total", "in": "query", "description": "include_items_total", "schema": { "type": "boolean", "description": "include_items_total" } }, { "name": "presentation", "in": "query", "schema": { "$ref": "#/components/schemas/PresentationModes" } }, { "name": "operation", "in": "query", "description": "operation", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TransactionOperationTypes" }, "description": "operation" } }, { "name": "registered_at_from", "in": "query", "description": "registered_at_from", "schema": { "type": "string", "description": "registered_at_from", "format": "date-time" } }, { "name": "registered_at_to", "in": "query", "description": "registered_at_to", "schema": { "type": "string", "description": "registered_at_to", "format": "date-time" } }, { "name": "amount_from", "in": "query", "description": "amount_from", "schema": { "type": "integer", "description": "amount_from", "format": "int64" } }, { "name": "amount_to", "in": "query", "description": "amount_to", "schema": { "type": "integer", "description": "amount_to", "format": "int64" } }, { "name": "X-LP-Client-Identifier", "in": "header", "description": "ClientIdentifier", "required": true, "schema": { "type": "string" }, "example": "375763a4-66e0-45ec-baa4-db6662ec6224" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "be21f40f-a0f1-4a1a-8657-d54ab001fd69" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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": "00247262-a959-4168-8066-2cc3f683622a" }, { "name": "X-LP-Client-Type", "in": "header", "description": "ClientType", "required": true, "schema": { "enum": [ "Unknown", "App", "WebApp", "Service", "Android" ], "type": "string" }, "example": "App" }, { "name": "X-LP-Client-Name", "in": "header", "description": "ClientName", "schema": { "type": "string" }, "example": "Swagger" }, { "name": "X-LP-Client-OS-Name", "in": "header", "description": "ClientOSName", "schema": { "type": "string" }, "example": "SwaggerDoc" }, { "name": "X-LP-Client-OS-Version", "in": "header", "description": "ClientOSVersion", "schema": { "type": "string" }, "example": "1.0" }, { "name": "X-LP-Client-Screen-Resolution", "in": "header", "description": "ClientScreenResolution", "schema": { "type": "string" }, "example": "1280x0900" }, { "name": "X-LP-Client-Model", "in": "header", "description": "ClientModel", "schema": { "type": "string" }, "example": "Chrome 75" }, { "name": "X-LP-Organization-Alias", "in": "header", "description": "OrganizationAlias", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Client-Extensions", "in": "header", "description": "ClientExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-Client-Extensions", "in": "header", "description": "ClientDepersonalizedExtensions", "schema": { "type": "string", "format": "csv" }, "example": "" }, { "name": "X-LP-Client-App-Version", "in": "header", "description": "ClientAppVersion", "schema": { "type": "string" }, "example": "" }, { "name": "X-LP-Employee-Guid", "in": "header", "description": "EmployeeGuid", "schema": { "type": "string", "format": "uuid" }, "example": "" }, { "name": "Accept-Language", "in": "header", "description": "Language", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "500": { "description": "Internal 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": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "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 }, "CheckWorkplaceNumberAvailabilityParams": { "type": "object", "properties": { "number": { "type": "integer", "description": "number", "format": "int64", "nullable": true }, "exclude_guid": { "type": "string", "description": "exclude_guid", "format": "uuid", "nullable": true } }, "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 }, "product_group": { "$ref": "#/components/schemas/ProductGroups" }, "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, "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 }, "EmployeeImportColumnMapping": { "type": "object", "properties": { "first_data_row": { "type": "integer", "description": "first_data_row", "format": "int32" }, "employee_name_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "employee_name_column", "nullable": true }, "employee_role_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "employee_role_column", "nullable": true }, "employee_phone_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "employee_phone_column", "nullable": true }, "employee_email_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "employee_email_column", "nullable": true }, "is_default": { "type": "boolean", "description": "is_default", "readOnly": true } }, "additionalProperties": false }, "EmployeeImportFromExcelParams": { "type": "object", "properties": { "attributes_for_matching": { "$ref": "#/components/schemas/EmployeeImportMatchingAttributes" }, "column_mapping": { "$ref": "#/components/schemas/EmployeeImportColumnMapping" } }, "additionalProperties": false }, "EmployeeImportMatchingAttributes": { "type": "object", "properties": { "use_phone": { "type": "boolean", "description": "use_phone" } }, "additionalProperties": false }, "EmployeeImportPreviewItem": { "type": "object", "properties": { "before": { "$ref": "#/components/schemas/Employee" }, "after": { "$ref": "#/components/schemas/Employee" } }, "additionalProperties": false }, "EmployeeImportPreviewItemPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeImportPreviewItem" }, "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 }, "EmployeeImportTask": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/IEmployeeImportParams" }, "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 }, "EmployeeImportTaskPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeImportTask" }, "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 }, "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" }, "vat_rate": { "$ref": "#/components/schemas/FEValueAddedTaxCodes" }, "sum_of_vat": { "type": "integer", "description": "sum_of_vat", "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", "fiscal_drive_expired_at_asc", "fiscal_drive_expired_at_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 }, "product_group": { "$ref": "#/components/schemas/ProductGroups" }, "is_package_of": { "maximum": 99999999, "minimum": 2, "type": "integer", "description": "is_package_of", "format": "int32", "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 }, "IEmployeeImportParams": { "type": "object", "properties": { "attributes_for_matching": { "$ref": "#/components/schemas/EmployeeImportMatchingAttributes" } }, "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 }, "good_product_group_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "good_product_group_column", "nullable": true }, "good_is_package_of_column": { "pattern": "^[a-zA-Z]{1,3}$", "type": "string", "description": "good_is_package_of_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 }, "is_package_of": { "maximum": 99999999, "minimum": 2, "type": "integer", "description": "is_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" }, "include_good_product_group_column": { "type": "boolean", "description": "include_good_product_group_column" }, "include_good_is_package_of_column": { "type": "boolean", "description": "include_good_is_package_of_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": "int64" }, "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" }, "ProductGroups": { "enum": [ "textiles", "footwear", "tobacco", "perfumery", "tires", "cameras", "dairy", "bicycles", "medtech", "alttobacco", "water", "fur", "beer", "nicotine", "supplements", "antiseptics", "petfood", "seafood", "nonalcoholicbeer", "softdrinks", "vetdrugs", "toys", "radioelectronics", "preserves", "vegetableoils", "cosmetics", "groceries", "construction", "motoroils", "confectionery" ], "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" }, "qp_transaction_id": { "type": "string", "description": "qp_transaction_id", "nullable": true }, "qp_bank_id": { "type": "string", "description": "qp_bank_id", "nullable": true }, "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": "int64" }, "currency": { "$ref": "#/components/schemas/CurrencyCodes" }, "print_view": { "type": "string", "description": "print_view", "nullable": true } }, "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 }, "ResetPasswordRequest": { "type": "object", "properties": { "send_sms": { "type": "boolean", "description": "send_sms" } }, "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 }, "ResetPinCodeRequest": { "type": "object", "properties": { "send_sms": { "type": "boolean", "description": "send_sms" } }, "additionalProperties": false }, "ResetPinCodeResponse": { "type": "object", "properties": { "pin_code": { "type": "string", "description": "pin_code", "nullable": true } }, "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 }, "SendCodeByPhoneCredentialsServiceResponse": { "type": "object", "properties": { "code": { "type": "string", "description": "code", "nullable": true } }, "additionalProperties": false }, "SendCodeByUsernameCredentials": { "required": [ "full_username" ], "type": "object", "properties": { "full_username": { "maxLength": 49, "minLength": 5, "type": "string", "description": "full_username" } }, "additionalProperties": false }, "ServiceRoleUserAccess": { "type": "object", "properties": { "initial_password": { "type": "string", "description": "initial_password", "nullable": true }, "pin_code": { "type": "string", "description": "pin_code", "nullable": true }, "token": { "type": "string", "description": "token", "nullable": true } }, "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 }, "max": { "maxLength": 64, "minLength": 2, "type": "string", "description": "max", "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": "EmployeeImport" }, { "name": "EmployeeImportTaskPreview" }, { "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" } ] }