2.0info: 4.1.0 xt_stock description: Integrador de Saldos físicos do estoque do ERP Senior X para o Compliance Fiscal x-senior-domain: erpx_int x-senior-domain-path: erpx_int x-senior-service-path: xt_stock contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erpx_intsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /xt_stock/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/queries/getTasksWithErrorFromTicket: post: description: Lista de tarefas com erro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticketId properties: ticketId: type: string description: Id do Ticket pageRequest: type: object allOf: – #/definitions/recPageRequest description: Page Request responses: 200: description: Ok schema: type: object required: – integrationTasks – totalElements properties: integrationTasks: type: array items: type: object allOf: – #/definitions/integrationTaskData minimum: 1 description: Lista de Tarefas totalElements: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/queries/getWorksWithErrorFromTask: post: description: Query para retornar a listagem dos trabalhos de integração com erro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – taskId properties: taskId: type: string description: Identificador da tarefa de integração pageRequest: type: object allOf: – #/definitions/recPageRequest description: Definição de paginação responses: 200: description: Ok schema: type: object required: – total properties: integrationWorks: type: array items: type: object allOf: – #/definitions/integrationWorkData description: Lista de trabalhos de integração total: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/queries/getWorksWithErrorFromInventory: post: description: Query para retornar a listagem dos trabalhos de integração com erro do saldo de estoque tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticketId properties: ticketId: type: string description: Identificador da tarefa de integração pageRequest: type: object allOf: – #/definitions/recPageRequest description: Definição de paginação responses: 200: description: Ok schema: type: object required: – total properties: integrationWorks: type: array items: type: object allOf: – #/definitions/integrationWorkData description: Lista de trabalhos de integração total: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/queries/getStockItemControlWithErrorFromWork: post: description: Query para retornar a listagem de todos os erros ocorridos dos itens do saldo de estoque tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – workId – pageRequest properties: workId: type: string description: Identificador do work pageRequest: type: object allOf: – #/definitions/recPageRequest description: Definição de paginação responses: 200: description: Ok schema: type: object required: – stockItemControls – total properties: stockItemControls: type: array items: type: object allOf: – #/definitions/stockItemControlData minimum: 1 description: Lista de stock item controls com erros total: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/queries/exportStockItemIntegrationResponse: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/queries/exportStockItemIntegrationControl: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/actions/performStockIntegration: post: description: Action para iniciar o processamento da integração do fechamento de estoque tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId – branchId – startDate – endDate properties: companyId: type: string description: Identificador da empresa branchId: type: string description: Identificador da filial startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: Ticket 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/actions/reprocessPendingIntegration: post: description: Resolver integração que esta pendente expirada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticketId properties: ticketId: type: string description: ticketId utilizado para tentar o reprocesso responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/actions/importStockItemIntegrationResponse: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/actions/importStockItemIntegrationControl: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/signals/processIntegrationResponseError: post: description: Signal que processa a resposta do xt integration em caso de adversidades durante a integração de estoque tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – responseIntegration properties: responseIntegration: type: object allOf: – #/definitions/recStockResponse description: Retorno do processamento da integração responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /xt_stock/signals/processIntegrationCallbackStock: post: description: Signal processamento da callback do xt-integration – resposta do processamento do ERPXT tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – responseIntegration properties: responseIntegration: type: object allOf: – #/definitions/recXtStockResponseIntegration description: Retorno execução da integração g5 responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /xt_stock/signals/startIntegration: post: description: Inicia a criação e processamento das tasks tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – ticketId – companyId – branchId – startDate – endDate properties: ticketId: type: string description: Ticket – Id do ticket companyId: type: string description: Identificador da empresa branchId: type: string description: Identificador da filial startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /xt_stock/signals/processIntegrationTask: post: description: Evento responsável por iniciar o processamento da task paralelizada tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – taskId – workerName – workers – lastWorkId properties: taskId: type: string description: Identificador da task workerName: type: string description: Nome do worker workers: type: integer format: int64 description: Número de workers lastWorkId: type: string description: identificador do último work alocado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /xt_stock/signals/updateStockClosingToDelete: post: description: Processa exclusão do fechamento de estoque no serviço de origem tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – branchId – stockClosingDate properties: branchId: type: string description: Identificador da filial stockClosingDate: type: string format: date description: Período do fechamento do estoque para exclusão responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /xt_stock/signals/integrationTaskFinished: post: description: Evento que sinaliza a finalização da task tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – taskId – taskStatus properties: taskId: type: string description: Identificador da task taskStatus: type: string allOf: – #/definitions/taskStatus description: Status de finalização da task msg: type: string description: Mensagem responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /xt_stock/signals/integrationTicketFinished: post: description: Evento que sinaliza a finalização do ticket tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – ticketId – ticketStatus properties: ticketId: type: string description: Identificador do ticket ticketStatus: type: string allOf: – #/definitions/ticketStatus description: Status de finalização do ticket msg: type: string description: Mensagem responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /xt_stock/events/integrationXtStockTicketFinished: post: description: Evento que sinaliza a finalização do ticket x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticketId – ticketStatus properties: ticketId: type: string description: Identificador do ticket ticketStatus: type: string allOf: – #/definitions/ticketStatus description: Status de finalização do ticket msg: type: string description: Mensagem responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /xt_stock/events/importStockItemIntegrationResponseEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /xt_stock/events/exportStockItemIntegrationResponseEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /xt_stock/events/importStockItemIntegrationControlEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /xt_stock/events/exportStockItemIntegrationControlEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /xt_stock/entities/stockItemIntegrationResponse: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/stockItemIntegrationResponse responses: 200: description: The created resource schema: #/definitions/stockItemIntegrationResponse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/stockItemIntegrationResponse responses: 200: description: The created resource schema: #/definitions/stockItemIntegrationResponse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/stockItemIntegrationResponse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/entities/stockItemIntegrationResponse/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editStockItemIntegrationResponse responses: 200: description: Ok schema: #/definitions/editStockItemIntegrationResponse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/stockItemIntegrationResponse responses: 200: description: Ok schema: #/definitions/stockItemIntegrationResponse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/stockItemIntegrationResponse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/entities/stockItemIntegrationResponse/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/stockItemIntegrationResponse responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/entities/stockItemIntegrationControl: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/stockItemIntegrationControl responses: 200: description: The created resource schema: #/definitions/stockItemIntegrationControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/stockItemIntegrationControl responses: 200: description: The created resource schema: #/definitions/stockItemIntegrationControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/stockItemIntegrationControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/entities/stockItemIntegrationControl/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editStockItemIntegrationControl responses: 200: description: Ok schema: #/definitions/editStockItemIntegrationControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/stockItemIntegrationControl responses: 200: description: Ok schema: #/definitions/stockItemIntegrationControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/stockItemIntegrationControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_stock/entities/stockItemIntegrationControl/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/stockItemIntegrationControl responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: enumItemStatusIntegration: type: string enum: – INTEGRATED – ERROR – PROCESSING upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumTypeExternalStatusIntegration: type: string enum: – SUCCESS – ERROR description: Enum de status callbackResponse: * `SUCCESS` – Sucesso * `ERROR` – Erro enumTypeOrder: type: string enum: – ASC – DESC description: Enumaração para o tipo de ordenação: * `ASC` – Tipo de ordenação – Crescente * `DESC` – Tipo de ordenação – Decrescente taskStatus: type: string enum: – STARTING – PROCESSING – DONE – DONE_WITH_ERROR – ERROR – CANCELED – EXTERNAL_PROCESSING description: Status da tarefa de integração: * `STARTING` – Iniciando * `PROCESSING` – Processando * `DONE` – Finalizado * `DONE_WITH_ERROR` – Finalizado com erro * `ERROR` – Erro * `CANCELED` – Cancelada * `EXTERNAL_PROCESSING` – aguardando processos externos workStatus: type: string enum: – WAITING – PENDING – PROCESSING – DONE – ERROR – CANCELED – PAUSED description: Status da tarefa de integração: * `WAITING` – Esperando * `PENDING` – Pendente * `PROCESSING` – Processando * `DONE` – Concluído * `ERROR` – Erro * `CANCELED` – Cancelado * `PAUSED` – Pausado, aguardando dados/processos externos ticketStatus: type: string enum: – PROCESSING – FINISHED – FINISHED_WITH_ERROR description: Status do Ticket: * `PROCESSING` – Processando * `FINISHED` – Finalizado * `FINISHED_WITH_ERROR` – Finalizado userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error stockItemIntegrationResponse: description: Entidade responsável pelo controle de resposta da integração – Saldo de Estoque type: object required: – status – message properties: id: type: string format: uuid description: Identificador entidade idWork: type: string format: uuid description: Identificador trabalhos integração idExternal: type: string description: Identificador entidades externas – cpl_xt/integration/integrationProcessDetail status: type: string allOf: – #/definitions/enumTypeExternalStatusIntegration description: Status da execução message: type: string description: Detalhes da mensagem de resposta usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editStockItemIntegrationResponse: type: object required: – id allOf: – #/definitions/stockItemIntegrationResponse stockItemIntegrationControl: description: Entidade que controla a situação da integração dos itens do saldo de estoque vinculados a um work type: object required: – status properties: id: type: string format: uuid description: Identificador da entidade itemId: type: string format: uuid description: Id do item do estoque stockId: type: string format: uuid description: Identificador do periodo do estoque itemProductId: type: string format: uuid description: Identificador do produto do item do estoque idWork: type: string format: uuid description: Identificador trabalhos integração status: type: string allOf: – #/definitions/enumItemStatusIntegration description: Status de integração do item message: type: string maxLength: 1000 description: Mensagem de resposta usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editStockItemIntegrationControl: type: object required: – id allOf: – #/definitions/stockItemIntegrationControl checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recXtStockResponseIntegration: description: Dados do retorno do processamento do xt-integration type: object required: – idWork – integrationId – status – message properties: idWork: type: string description: UUID integração keyId: type: string description: Key id (id do produto de tal item do estoque) integrationId: type: string description: UUID do controle do serviço xt-integration status: type: string allOf: – #/definitions/enumTypeExternalStatusIntegration description: Status message: type: string description: Message recStockResponse: description: Dados do retorno do processamento do xt-integration type: object required: – idWork – message properties: idWork: type: string description: UUID integração message: type: string description: Message recPageRequest: description: Define a paginação da query type: object required: – offset – size properties: offset: type: integer format: int64 description: Número da página size: type: integer format: int64 description: Quantidade de registros por página orderBy: type: array items: type: object allOf: – #/definitions/fieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados fieldsOrderBy: description: Define o registro com os dados dos campos à serem ordenados type: object required: – field – order properties: field: type: string description: Nome do campo a ser ordenado order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação do campo (ASC / DESC) integrationTaskData: description: Tarefa integração type: object required: – id – ticket – description – taskStatus – taskDate properties: id: type: string description: Id da Integração ticket: type: string description: Ticket description: type: string description: Descrição taskStatus: type: string allOf: – #/definitions/taskStatus description: Status da tarefa taskDate: type: string format: date description: Data da tarefa message: type: string description: Mensagem numberOfOccurrences: type: integer format: int64 description: Número de ocorrências integrationWorkData: description: Record para listagem de trabalhos de integração com erro type: object required: – id – taskId properties: id: type: string description: Identificador do trabalho de integração taskId: type: string description: Identificador da tarefa workStatus: type: string allOf: – #/definitions/workStatus description: Status da tarefa de integração message: type: string description: Mensagem stockItemControlData: description: Record para listagem das mensagens de erro dos itens de integração de saldo de estoque com erros type: object required: – message – dthalt properties: message: type: string description: Mensagem de erro dthalt: type: string format: date-time description: Data de alteração notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage