inv_inventario

2.0info: 0.1.1 inv_inventario description: Inventário de estoques x-senior-domain: erp_sup x-senior-domain-path: erp_sup x-senior-service-path: inv_inventario contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erp_supsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /inv_inventario/queries/pesquisarDeposito: post: description: Retorna depósitos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – tipoDeposito properties: empresa: type: integer format: int64 description: Empresa tipoDeposito: type: integer format: int64 description: Tipo de depósito responses: 200: description: Ok schema: type: object required: – depositos properties: depositos: type: array items: type: object allOf: – #/definitions/recDeposito minimum: 1 description: Depósitos default: description: Error response schema: #/definitions/genericError get: description: Retorna depósitos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: tipoDeposito in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – depositos properties: depositos: type: array items: type: object allOf: – #/definitions/recDeposito minimum: 1 description: Depósitos default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/pesquisarInventario: post: description: Retorna inventários tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – inventariosAbertos properties: empresa: type: integer format: int64 description: Empresa dataInventario: type: string format: date description: Data do inventário deposito: type: string description: Depósito inventariosAbertos: type: boolean description: Considerar inventários abertos responses: 200: description: Ok schema: type: object required: – inventarios properties: inventarios: type: array items: type: object allOf: – #/definitions/recInventario minimum: 1 description: Inventários default: description: Error response schema: #/definitions/genericError get: description: Retorna inventários tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: dataInventario in: query type: string format: date – name: deposito in: query type: string – name: inventariosAbertos in: query required: true type: boolean responses: 200: description: Ok schema: type: object required: – inventarios properties: inventarios: type: array items: type: object allOf: – #/definitions/recInventario minimum: 1 description: Inventários default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/pesquisarLote: post: description: Retorna lotes disponíveis no depósito tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa properties: empresa: type: integer format: int64 description: Empresa deposito: type: string description: Depósito responses: 200: description: Ok schema: type: object required: – lotes properties: lotes: type: array items: type: object allOf: – #/definitions/recLote minimum: 1 description: Lotes default: description: Error response schema: #/definitions/genericError get: description: Retorna lotes disponíveis no depósito tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: deposito in: query type: string responses: 200: description: Ok schema: type: object required: – lotes properties: lotes: type: array items: type: object allOf: – #/definitions/recLote minimum: 1 description: Lotes default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/pesquisarGrupoEstoque: post: description: Retorna agrupamentos de estoque tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa properties: empresa: type: integer format: int64 description: Empresa responses: 200: description: Ok schema: type: object required: – gruposEstoque properties: gruposEstoque: type: array items: type: object allOf: – #/definitions/recGrupoEstoque minimum: 1 description: Grupos de estoque default: description: Error response schema: #/definitions/genericError get: description: Retorna agrupamentos de estoque tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – gruposEstoque properties: gruposEstoque: type: array items: type: object allOf: – #/definitions/recGrupoEstoque minimum: 1 description: Grupos de estoque default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/pesquisarTipoProduto: post: description: Retorna tipos de produto tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – tiposProduto properties: tiposProduto: type: array items: type: object allOf: – #/definitions/recEnumerado minimum: 1 description: Tipos de produto default: description: Error response schema: #/definitions/genericError get: description: Retorna tipos de produto tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – tiposProduto properties: tiposProduto: type: array items: type: object allOf: – #/definitions/recEnumerado minimum: 1 description: Tipos de produto default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/pesquisarOrigem: post: description: Retorna origens tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa properties: empresa: type: integer format: int64 description: Empresa tipoProduto: type: string description: Tipos de produto responses: 200: description: Ok schema: type: object required: – origens properties: origens: type: array items: type: object allOf: – #/definitions/recOrigem minimum: 1 description: Origens default: description: Error response schema: #/definitions/genericError get: description: Retorna origens tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: tipoProduto in: query type: string responses: 200: description: Ok schema: type: object required: – origens properties: origens: type: array items: type: object allOf: – #/definitions/recOrigem minimum: 1 description: Origens default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/pesquisarFamilia: post: description: Retorna familias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa properties: empresa: type: integer format: int64 description: Empresa tipoProduto: type: string description: Tipo de produto origem: type: string description: Origem responses: 200: description: Ok schema: type: object required: – familias properties: familias: type: array items: type: object allOf: – #/definitions/recFamilia minimum: 1 description: Famílias default: description: Error response schema: #/definitions/genericError get: description: Retorna familias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: tipoProduto in: query type: string – name: origem in: query type: string responses: 200: description: Ok schema: type: object required: – familias properties: familias: type: array items: type: object allOf: – #/definitions/recFamilia minimum: 1 description: Famílias default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/pesquisarProduto: post: description: Retorna produtos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa properties: empresa: type: integer format: int64 description: Empresa tipoProduto: type: string description: Tipo de produto origem: type: string description: Origem familia: type: string description: Família grupoEstoque: type: string description: Grupo de estoque situacaoProduto: type: string description: Situação do produto qualidadeProduto: type: string description: Qualidade do produto responses: 200: description: Ok schema: type: object required: – produtos properties: produtos: type: array items: type: object allOf: – #/definitions/recProduto minimum: 1 description: Produtos default: description: Error response schema: #/definitions/genericError get: description: Retorna produtos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: tipoProduto in: query type: string – name: origem in: query type: string – name: familia in: query type: string – name: grupoEstoque in: query type: string – name: situacaoProduto in: query type: string – name: qualidadeProduto in: query type: string responses: 200: description: Ok schema: type: object required: – produtos properties: produtos: type: array items: type: object allOf: – #/definitions/recProduto minimum: 1 description: Produtos default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/pesquisarDerivacao: post: description: Retorna derivações do produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – produto properties: empresa: type: integer format: int64 description: Empresa produto: type: string description: Produto situacaoDerivacao: type: string description: Situação da derivação responses: 200: description: Ok schema: type: object required: – derivacoes properties: derivacoes: type: array items: type: object allOf: – #/definitions/recDerivacao minimum: 1 description: Derivações default: description: Error response schema: #/definitions/genericError get: description: Retorna derivações do produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: produto in: query required: true type: string – name: situacaoDerivacao in: query type: string responses: 200: description: Ok schema: type: object required: – derivacoes properties: derivacoes: type: array items: type: object allOf: – #/definitions/recDerivacao minimum: 1 description: Derivações default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/pesquisarFabricante: post: description: Retorna fabricantes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa properties: empresa: type: integer format: int64 description: Empresa produto: type: string description: Produto derivacao: type: string description: Derivação responses: 200: description: Ok schema: type: object required: – fabricantes properties: fabricantes: type: array items: type: object allOf: – #/definitions/recFabricante minimum: 1 description: Fabricantes default: description: Error response schema: #/definitions/genericError get: description: Retorna fabricantes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: produto in: query type: string – name: derivacao in: query type: string responses: 200: description: Ok schema: type: object required: – fabricantes properties: fabricantes: type: array items: type: object allOf: – #/definitions/recFabricante minimum: 1 description: Fabricantes default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/pesquisarEnderecamento: post: description: Retorna endereçamentos de produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa properties: empresa: type: integer format: int64 description: Empresa familia: type: string description: Família responses: 200: description: Ok schema: type: object required: – enderecamentos properties: enderecamentos: type: array items: type: object allOf: – #/definitions/recEnderecamento minimum: 1 description: Endereçamentos default: description: Error response schema: #/definitions/genericError get: description: Retorna endereçamentos de produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: familia in: query type: string responses: 200: description: Ok schema: type: object required: – enderecamentos properties: enderecamentos: type: array items: type: object allOf: – #/definitions/recEnderecamento minimum: 1 description: Endereçamentos default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/pesquisarQualidadeProduto: post: description: Retorna qualidades do produto tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – qualidades properties: qualidades: type: array items: type: object allOf: – #/definitions/recEnumerado minimum: 1 description: Qualidades do produto default: description: Error response schema: #/definitions/genericError get: description: Retorna qualidades do produto tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – qualidades properties: qualidades: type: array items: type: object allOf: – #/definitions/recEnumerado minimum: 1 description: Qualidades do produto default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/pesquisarContaReduzida: post: description: Retorna contas reduzidas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa properties: empresa: type: integer format: int64 description: Empresa responses: 200: description: Ok schema: type: object required: – contasReduzidas properties: contasReduzidas: type: array items: type: object allOf: – #/definitions/recContaReduzida minimum: 1 description: Contas reduzidas default: description: Error response schema: #/definitions/genericError get: description: Retorna contas reduzidas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – contasReduzidas properties: contasReduzidas: type: array items: type: object allOf: – #/definitions/recContaReduzida minimum: 1 description: Contas reduzidas default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/pesquisarContaFinanceira: post: description: Retorna contas financeiras tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa properties: empresa: type: integer format: int64 description: Empresa responses: 200: description: Ok schema: type: object required: – contasFinanceiras properties: contasFinanceiras: type: array items: type: object allOf: – #/definitions/recContaFinanceira minimum: 1 description: Contas financeiras default: description: Error response schema: #/definitions/genericError get: description: Retorna contas financeiras tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – contasFinanceiras properties: contasFinanceiras: type: array items: type: object allOf: – #/definitions/recContaFinanceira minimum: 1 description: Contas financeiras default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/pesquisarCentroDeCusto: post: description: Retorna centros de custo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa properties: empresa: type: integer format: int64 description: Empresa contaReduzida: type: integer format: int64 description: Conta reduzida contaFinanceira: type: integer format: int64 description: Conta financeira responses: 200: description: Ok schema: type: object required: – centrosDeCusto properties: centrosDeCusto: type: array items: type: object allOf: – #/definitions/recCentroDeCusto minimum: 1 description: Centros de custo default: description: Error response schema: #/definitions/genericError get: description: Retorna centros de custo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: contaReduzida in: query type: integer format: int64 – name: contaFinanceira in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – centrosDeCusto properties: centrosDeCusto: type: array items: type: object allOf: – #/definitions/recCentroDeCusto minimum: 1 description: Centros de custo default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/pesquisarTransacao: post: description: Retorna transações de entrada ou saída para acerto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa properties: empresa: type: integer format: int64 description: Empresa entradaOuSaida: type: string description: Indicativo de (E)entrada ou (S)saída responses: 200: description: Ok schema: type: object required: – transacoes properties: transacoes: type: array items: type: object allOf: – #/definitions/recTransacao minimum: 1 description: Transações default: description: Error response schema: #/definitions/genericError get: description: Retorna transações de entrada ou saída para acerto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: entradaOuSaida in: query type: string responses: 200: description: Ok schema: type: object required: – transacoes properties: transacoes: type: array items: type: object allOf: – #/definitions/recTransacao minimum: 1 description: Transações default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/pesquisarMotivo: post: description: Retorna motivos para acerto tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – motivos properties: motivos: type: array items: type: object allOf: – #/definitions/recMotivo minimum: 1 description: Motivos default: description: Error response schema: #/definitions/genericError get: description: Retorna motivos para acerto tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – motivos properties: motivos: type: array items: type: object allOf: – #/definitions/recMotivo minimum: 1 description: Motivos default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirDeposito: post: description: Consiste depósito ativo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – deposito – tipoDeposito properties: empresa: type: integer format: int64 description: Empresa deposito: type: string description: Depósito tipoDeposito: type: integer format: int64 description: Tipo de depósito responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste depósito ativo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: deposito in: query required: true type: string – name: tipoDeposito in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirInventario: post: description: Consiste inventário fechado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – inventariosAbertos properties: empresa: type: integer format: int64 description: Empresa dataInventario: type: string format: date description: Data do inventário deposito: type: string description: Depósito inventariosAbertos: type: boolean description: Considerar inventários abertos responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste inventário fechado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: dataInventario in: query type: string format: date – name: deposito in: query type: string – name: inventariosAbertos in: query required: true type: boolean responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirLote: post: description: Consiste lote tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – lote properties: empresa: type: integer format: int64 description: Empresa deposito: type: string description: Depósito lote: type: string description: Lote responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste lote tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: deposito in: query type: string – name: lote in: query required: true type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirGrupoEstoque: post: description: Consite agrupamento de estoque tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – grupoEstoque properties: empresa: type: integer format: int64 description: Empresa grupoEstoque: type: string description: Grupo de estoque responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consite agrupamento de estoque tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: grupoEstoque in: query required: true type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirTipoProduto: post: description: Consiste tipo de produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipoProduto properties: tipoProduto: type: string description: Tipo de produto responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste tipo de produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tipoProduto in: query required: true type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirOrigem: post: description: Consiste origem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – origem properties: empresa: type: integer format: int64 description: Empresa tipoProduto: type: string description: Tipo de produto origem: type: string description: Origem responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste origem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: tipoProduto in: query type: string – name: origem in: query required: true type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirFamilia: post: description: Consiste família tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – familia properties: empresa: type: integer format: int64 description: Empresa tipoProduto: type: string description: Tipo de produto origem: type: string description: Origem familia: type: string description: Família responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste família tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: tipoProduto in: query type: string – name: origem in: query type: string – name: familia in: query required: true type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirProduto: post: description: Consiste produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – produto properties: empresa: type: integer format: int64 description: Empresa produto: type: string description: Produto tipoProduto: type: string description: Tipo de produto origem: type: string description: Origem familia: type: string description: Familia grupoEstoque: type: string description: Grupo de estoque situacaoProduto: type: string description: Situação do produto qualidadeProduto: type: string description: Qualidade do produto responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: produto in: query required: true type: string – name: tipoProduto in: query type: string – name: origem in: query type: string – name: familia in: query type: string – name: grupoEstoque in: query type: string – name: situacaoProduto in: query type: string – name: qualidadeProduto in: query type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirDerivacao: post: description: Consiste derivação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – produto – derivacao properties: empresa: type: integer format: int64 description: Empresa produto: type: string description: Produto derivacao: type: string description: Derivação situacaoDerivacao: type: string description: Situação da derivação responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste derivação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: produto in: query required: true type: string – name: derivacao in: query required: true type: string – name: situacaoDerivacao in: query type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirCurvaABC: post: description: Consiste curva ABC tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – curvaABC properties: curvaABC: type: string description: Curva ABC responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste curva ABC tags: – Queries x-senior-visibility: PRIVATE parameters: – name: curvaABC in: query required: true type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirFabricante: post: description: Consiste fabricante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – fabricante properties: empresa: type: integer format: int64 description: Empresa fabricante: type: string description: Fabricante responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste fabricante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: fabricante in: query required: true type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirEnderecamento: post: description: Consiste endereçamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – enderecamento properties: empresa: type: integer format: int64 description: Empresa enderecamento: type: string description: Endereçamento responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste endereçamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: enderecamento in: query required: true type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirDescricaoEnderecamento: post: description: Consiste descrição do endereçamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – descricaoEnderecamento properties: descricaoEnderecamento: type: string description: Descrição do endereçamento responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste descrição do endereçamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: descricaoEnderecamento in: query required: true type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirQualidadeProduto: post: description: Consiste qualidade do produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – qualidade properties: qualidade: type: string description: Qualidade do produto responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste qualidade do produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: qualidade in: query required: true type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirNumeroSerie: post: description: Consiste número de série tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – numeroSerie – produto – derivacao – deposito – quantidadeDiferenca properties: empresa: type: integer format: int64 description: Empresa numeroSerie: type: string description: Numero de série produto: type: string description: Produto derivacao: type: string description: Derivação deposito: type: string description: Depósito quantidadeDiferenca: type: number format: double description: Quantidade da diferença responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste número de série tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: numeroSerie in: query required: true type: string – name: produto in: query required: true type: string – name: derivacao in: query required: true type: string – name: deposito in: query required: true type: string – name: quantidadeDiferenca in: query required: true type: number format: double responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirContaReduzida: post: description: Consiste conta reduzida tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – contaReduzida properties: empresa: type: integer format: int64 description: Empresa contaReduzida: type: integer format: int64 description: Conta reduzida responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste conta reduzida tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: contaReduzida in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirContaFinanceira: post: description: Consiste conta financeira tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – contaFinanceira properties: empresa: type: integer format: int64 description: Empresa contaFinanceira: type: integer format: int64 description: Conta financeira responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste conta financeira tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: contaFinanceira in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirCentroDeCusto: post: description: Consiste centro de custo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – centroDeCusto properties: empresa: type: integer format: int64 description: Empresa centroDeCusto: type: string description: Centro de custo contaReduzida: type: integer format: int64 description: Conta reduzida contaFinanceira: type: integer format: int64 description: Conta financeira responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste centro de custo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: centroDeCusto in: query required: true type: string – name: contaReduzida in: query type: integer format: int64 – name: contaFinanceira in: query type: integer format: int64 responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirTransacao: post: description: Consiste transação de entrada ou saída para acerto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – transacao – entradaOuSaida properties: empresa: type: integer format: int64 description: Empresa transacao: type: string description: Transação entradaOuSaida: type: string description: Indicativo se (E)entrada ou (S)saída responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste transação de entrada ou saída para acerto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: transacao in: query required: true type: string – name: entradaOuSaida in: query required: true type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirMotivo: post: description: Consiste motivo do acerto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – motivo properties: motivo: type: integer format: int64 description: Motivo responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste motivo do acerto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: motivo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/buscarParametrosInventario: post: description: Consulta dados do inventário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – dataInventario – deposito properties: empresa: type: integer format: int64 description: Empresa dataInventario: type: string format: date description: Data do inventário deposito: type: string description: Depósito responses: 200: description: Ok schema: type: object required: – inventario properties: inventario: type: object allOf: – #/definitions/recParamInventario description: Inventário default: description: Error response schema: #/definitions/genericError get: description: Consulta dados do inventário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: dataInventario in: query required: true type: string format: date – name: deposito in: query required: true type: string responses: 200: description: Ok schema: type: object required: – inventario properties: inventario: type: object allOf: – #/definitions/recParamInventario description: Inventário default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirSeProdutoControladoPorLote: post: description: Verifica se um produto é controlado por lote tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – produto properties: empresa: type: integer format: int64 description: Emprsa produto: type: string description: Produto responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Verifica se um produto é controlado por lote tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: produto in: query required: true type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/retornarSeDepositoIntegraWMS: post: description: Retornar se depósito integra com WMS tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – deposito properties: empresa: type: integer format: int64 description: Empresa deposito: type: string description: Depósito responses: 200: description: Ok schema: type: object required: – integraComWMS properties: integraComWMS: type: boolean description: Indicativo se integra com WMS default: description: Error response schema: #/definitions/genericError get: description: Retornar se depósito integra com WMS tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: deposito in: query required: true type: string responses: 200: description: Ok schema: type: object required: – integraComWMS properties: integraComWMS: type: boolean description: Indicativo se integra com WMS default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/retornarParametrosEmpresa: post: description: Retornar parâmetros da empresa/filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa properties: empresa: type: integer format: int64 description: Empresa responses: 200: description: Ok schema: type: object required: – segmentoAgronegocio properties: segmentoAgronegocio: type: boolean description: Indicativo se empresa é do segmento de agronegócio default: description: Error response schema: #/definitions/genericError get: description: Retornar parâmetros da empresa/filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – segmentoAgronegocio properties: segmentoAgronegocio: type: boolean description: Indicativo se empresa é do segmento de agronegócio default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/retornarProdutosParaFinalizacao: post: description: Retorna lista de produtos para finalização e acerto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – filial – deposito – dataInventario – modalidade properties: empresa: type: integer format: int64 description: Empresa filial: type: integer format: int64 description: Filial deposito: type: string description: Depósito dataInventario: type: string format: date description: Data do inventário grupoEstoque: type: string description: Grupo de estoque tipoProduto: type: string description: Tipo de produto origem: type: string description: Origem familia: type: string description: Família produto: type: string description: Produto derivacao: type: string description: Derivação situacaoEstoque: type: string description: Situação do estoque situacaoProduto: type: string description: Situação do produto situacaoDerivacao: type: string description: Situação da derivação fabricante: type: string description: Fabricante enderecamento: type: string description: Endereçamento enderecamentoProduto: type: string description: Endereçamento do produto enderecamentoDeposito: type: string description: Endereçamento do depósito qualidadeProduto: type: string description: Qualidade do produto modalidade: type: integer format: int64 description: Valores para modalidade: 0=sem Diferença 1=com Diferença 2=Todos c/ Acerto Est. 3=Todos s/ Acerto Est. ignorarSeriesSemSaldoOuContagem: type: boolean description: Indicativo para descartar produtos com series sem saldo ou sem contagem (padrão=falso) agregarProdutosJaFinalizados: type: boolean description: Indicativo para retornar também produtos já finalizados (padrao=falso) responses: 200: description: Ok schema: type: object required: – produtos properties: produtos: type: array items: type: object allOf: – #/definitions/recProdutosParaFinalizacao minimum: 1 description: Produtos default: description: Error response schema: #/definitions/genericError get: description: Retorna lista de produtos para finalização e acerto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: filial in: query required: true type: integer format: int64 – name: deposito in: query required: true type: string – name: dataInventario in: query required: true type: string format: date – name: grupoEstoque in: query type: string – name: tipoProduto in: query type: string – name: origem in: query type: string – name: familia in: query type: string – name: produto in: query type: string – name: derivacao in: query type: string – name: situacaoEstoque in: query type: string – name: situacaoProduto in: query type: string – name: situacaoDerivacao in: query type: string – name: fabricante in: query type: string – name: enderecamento in: query type: string – name: enderecamentoProduto in: query type: string – name: enderecamentoDeposito in: query type: string – name: qualidadeProduto in: query type: string – name: modalidade in: query required: true type: integer format: int64 – name: ignorarSeriesSemSaldoOuContagem in: query type: boolean – name: agregarProdutosJaFinalizados in: query type: boolean responses: 200: description: Ok schema: type: object required: – produtos properties: produtos: type: array items: type: object allOf: – #/definitions/recProdutosParaFinalizacao minimum: 1 description: Produtos default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/buscarParametrosContagem: post: description: Retorna parâmetros da contagem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – filial – dataInventario – deposito properties: empresa: type: integer format: int64 description: Empresa filial: type: integer format: int64 description: Filial dataInventario: type: string format: date description: Data do inventário deposito: type: string description: Depósito responses: 200: description: Ok schema: type: object required: – inventario properties: inventario: type: object allOf: – #/definitions/recParametrosContagem description: Inventário default: description: Error response schema: #/definitions/genericError get: description: Retorna parâmetros da contagem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: filial in: query required: true type: integer format: int64 – name: dataInventario in: query required: true type: string format: date – name: deposito in: query required: true type: string responses: 200: description: Ok schema: type: object required: – inventario properties: inventario: type: object allOf: – #/definitions/recParametrosContagem description: Inventário default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/buscarItensContagem: post: description: Retorna itens da contagem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – filial – dataInventario – deposito – modalidade – saldoDosLotes properties: empresa: type: integer format: int64 description: Empresa filial: type: integer format: int64 description: Filial dataInventario: type: string format: date description: Data do inventário deposito: type: string description: Depósito modalidade: type: integer format: int64 description: Modalidade saldoDosLotes: type: string allOf: – #/definitions/enumSaldoLotes description: Saldo dos lotes grupoEstoque: type: string description: Grupo de estoque tipoProduto: type: string description: Tipo de produto origem: type: string description: Origem familia: type: string description: Família produto: type: string description: Produto derivacao: type: string description: Derivação fabricante: type: string description: Fabricante enderecamento: type: string description: Endereçamento enderecamentoProduto: type: string description: Endereçamento do produto enderecamentoDeposito: type: string description: Endereçamento do depósito periodoFabricacaoInicial: type: string format: date description: Período de fabricação inicial periodoFabricacaoFinal: type: string format: date description: Período de fabricação final periodoValidadeInicial: type: string format: date description: Período de validade inicial periodoValidadeFinal: type: string format: date description: Período de validade final qualidadeProduto: type: string description: Qualidade do produto responses: 200: description: Ok schema: type: object required: – itemInventario properties: itemInventario: type: object allOf: – #/definitions/recItemInventario description: Item do inventário default: description: Error response schema: #/definitions/genericError get: description: Retorna itens da contagem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: filial in: query required: true type: integer format: int64 – name: dataInventario in: query required: true type: string format: date – name: deposito in: query required: true type: string – name: modalidade in: query required: true type: integer format: int64 – name: saldoDosLotes in: query required: true type: string allOf: – #/definitions/enumSaldoLotes – name: grupoEstoque in: query type: string – name: tipoProduto in: query type: string – name: origem in: query type: string – name: familia in: query type: string – name: produto in: query type: string – name: derivacao in: query type: string – name: fabricante in: query type: string – name: enderecamento in: query type: string – name: enderecamentoProduto in: query type: string – name: enderecamentoDeposito in: query type: string – name: periodoFabricacaoInicial in: query type: string format: date – name: periodoFabricacaoFinal in: query type: string format: date – name: periodoValidadeInicial in: query type: string format: date – name: periodoValidadeFinal in: query type: string format: date – name: qualidadeProduto in: query type: string responses: 200: description: Ok schema: type: object required: – itemInventario properties: itemInventario: type: object allOf: – #/definitions/recItemInventario description: Item do inventário default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/retornarItemViaCodigoBarra: post: description: Retorna um item para contagem via código de barras tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – filial – dataInventario – deposito – tipoCodigoBarras – codigoBarra – qtdeMovimento – modalidade – saldoDosLotes properties: empresa: type: integer format: int64 description: Empresa filial: type: integer format: int64 description: Filial dataInventario: type: string format: date description: Data do inventário deposito: type: string description: Depósito tipoCodigoBarras: type: string allOf: – #/definitions/tipoCodigoBarras description: Tipo de código de barras codigoBarra: type: string description: Código de barras qtdeMovimento: type: number format: double description: Quantidade do movimento modalidade: type: integer format: int64 description: Modalidade saldoDosLotes: type: string allOf: – #/definitions/enumSaldoLotes description: Saldo dos lotes responses: 200: description: Ok schema: type: object required: – iteminventario properties: iteminventario: type: object allOf: – #/definitions/recItemInventario description: Item do inventário default: description: Error response schema: #/definitions/genericError get: description: Retorna um item para contagem via código de barras tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: filial in: query required: true type: integer format: int64 – name: dataInventario in: query required: true type: string format: date – name: deposito in: query required: true type: string – name: tipoCodigoBarras in: query required: true type: string allOf: – #/definitions/tipoCodigoBarras – name: codigoBarra in: query required: true type: string – name: qtdeMovimento in: query required: true type: number format: double – name: modalidade in: query required: true type: integer format: int64 – name: saldoDosLotes in: query required: true type: string allOf: – #/definitions/enumSaldoLotes responses: 200: description: Ok schema: type: object required: – iteminventario properties: iteminventario: type: object allOf: – #/definitions/recItemInventario description: Item do inventário default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirProdutoMultiVolume: post: description: Valida se o conjunto de volumes passados por parâmetro forma a quantidade de produtos completos esperada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – produto – derivacao – volumes – quantidadeProdutosCompletos properties: empresa: type: integer format: int64 description: Empresa produto: type: string description: Produto derivacao: type: string description: Derivação volumes: type: array items: type: string minimum: 1 description: Volumes quantidadeProdutosCompletos: type: integer format: int64 description: Quantidade de produtos completos responses: 200: description: Ok schema: type: object required: – volumesValidos – totalVolumesNecessarios – produtosCompletosLidos properties: volumesValidos: type: integer format: int64 description: Volumes válidos totalVolumesNecessarios: type: integer format: int64 description: Total de volumes necessários produtosCompletosLidos: type: integer format: int64 description: Produtos completos lidos default: description: Error response schema: #/definitions/genericError get: description: Valida se o conjunto de volumes passados por parâmetro forma a quantidade de produtos completos esperada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: produto in: query required: true type: string – name: derivacao in: query required: true type: string – name: volumes in: query required: true type: array items: type: string minimum: 1 – name: quantidadeProdutosCompletos in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – volumesValidos – totalVolumesNecessarios – produtosCompletosLidos properties: volumesValidos: type: integer format: int64 description: Volumes válidos totalVolumesNecessarios: type: integer format: int64 description: Total de volumes necessários produtosCompletosLidos: type: integer format: int64 description: Produtos completos lidos default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/obterQuantidadeVolumesProduto: post: description: Retorna a quantidade de volumes do produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – produto properties: empresa: type: integer format: int64 description: Empresa produto: type: string description: Produto responses: 200: description: Ok schema: type: object required: – quantidadeVolumes properties: quantidadeVolumes: type: integer format: int64 description: Quantidade de volumes default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de volumes do produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – quantidadeVolumes properties: quantidadeVolumes: type: integer format: int64 description: Quantidade de volumes default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/retornarPermissoesContagem: post: description: Retorna as permissões para contagem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – filial properties: empresa: type: integer format: int64 description: Empresa filial: type: integer format: int64 description: Filial responses: 200: description: Ok schema: type: object required: – permiteAdicionarProduto – permiteLerCodigoBarraDuplicado – permiteVisualizarQuantidadeEstoque properties: permiteAdicionarProduto: type: boolean description: Indicativo se permite adicionar produto permiteLerCodigoBarraDuplicado: type: boolean description: Indicativo se permite código de barras duplicado permiteVisualizarQuantidadeEstoque: type: boolean description: Indicativo se permite visualizar quantidade em estoque default: description: Error response schema: #/definitions/genericError get: description: Retorna as permissões para contagem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: filial in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – permiteAdicionarProduto – permiteLerCodigoBarraDuplicado – permiteVisualizarQuantidadeEstoque properties: permiteAdicionarProduto: type: boolean description: Indicativo se permite adicionar produto permiteLerCodigoBarraDuplicado: type: boolean description: Indicativo se permite código de barras duplicado permiteVisualizarQuantidadeEstoque: type: boolean description: Indicativo se permite visualizar quantidade em estoque default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/retornarEstadoCamposInclusaoLoteSerie: post: description: Devolve informações para controle do front-end tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – produto – derivacao properties: empresa: type: integer format: int64 description: Empresa produto: type: string description: Produto derivacao: type: string description: Derivação responses: 200: description: Ok schema: type: object required: – serieVisivel – loteVisivel – dataValidadeEditavel properties: serieVisivel: type: boolean description: Indicativo se série visível loteVisivel: type: boolean description: Indicativo se lote visível dataValidadeEditavel: type: boolean description: Indicativo de data de validade editável default: description: Error response schema: #/definitions/genericError get: description: Devolve informações para controle do front-end tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: produto in: query required: true type: string – name: derivacao in: query required: true type: string responses: 200: description: Ok schema: type: object required: – serieVisivel – loteVisivel – dataValidadeEditavel properties: serieVisivel: type: boolean description: Indicativo se série visível loteVisivel: type: boolean description: Indicativo se lote visível dataValidadeEditavel: type: boolean description: Indicativo de data de validade editável default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirInclusaoLoteSerie: post: description: Consiste a inclusão de um novo lote no inventário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – deposito – produto – derivacao – codigoLoteSerie – quantidade properties: empresa: type: integer format: int64 description: Empresa deposito: type: string description: Depósito produto: type: string description: Produto derivacao: type: string description: Derivação codigoLoteSerie: type: string description: Código do lote/série dataValidade: type: string format: date description: Data de validade dataFabricacao: type: string format: date description: Data de fabricação quantidade: type: number format: double description: Quantidade responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste a inclusão de um novo lote no inventário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: deposito in: query required: true type: string – name: produto in: query required: true type: string – name: derivacao in: query required: true type: string – name: codigoLoteSerie in: query required: true type: string – name: dataValidade in: query type: string format: date – name: dataFabricacao in: query type: string format: date – name: quantidade in: query required: true type: number format: double responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirQuantidadeContagem: post: description: Consiste a quantidade contada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – filial – deposito – produto – derivacao – quantidade properties: empresa: type: integer format: int64 description: Empresa filial: type: integer format: int64 description: Filial deposito: type: string description: Depósito produto: type: string description: Produto derivacao: type: string description: Derivação quantidade: type: number format: double description: Quantidade responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste a quantidade contada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: filial in: query required: true type: integer format: int64 – name: deposito in: query required: true type: string – name: produto in: query required: true type: string – name: derivacao in: query required: true type: string – name: quantidade in: query required: true type: number format: double responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirNumeroContagem: post: description: Consiste o número da contagem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – filial – dataInventario – deposito – numeroContagem properties: empresa: type: integer format: int64 description: Empresa filial: type: integer format: int64 description: Filial dataInventario: type: string format: date description: Data do inventário deposito: type: string description: Depósito numeroContagem: type: integer format: int64 description: Número da contagem responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste o número da contagem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: filial in: query required: true type: integer format: int64 – name: dataInventario in: query required: true type: string format: date – name: deposito in: query required: true type: string – name: numeroContagem in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/consistirQtdeAcertoAutomatico: post: description: Consiste a quantidade de acertos automáticos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – filial – dataInventario – deposito – quantidade properties: empresa: type: integer format: int64 description: Empresa filial: type: integer format: int64 description: Filial dataInventario: type: string format: date description: Data do inventário deposito: type: string description: Depósito quantidade: type: integer format: int64 description: Quantidade responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Consiste a quantidade de acertos automáticos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: filial in: query required: true type: integer format: int64 – name: dataInventario in: query required: true type: string format: date – name: deposito in: query required: true type: string – name: quantidade in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/gerarRelatorioContagem: post: description: Gera o relatório de contagem no formado PDF (codificado em base64) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – filial – dataInventario – deposito – numeroContagem properties: empresa: type: integer format: int64 description: Empresa filial: type: integer format: int64 description: Filial dataInventario: type: string format: date description: Data do inventário deposito: type: string description: Depósito numeroContagem: type: integer format: int64 description: Número da contagem responses: 200: description: Ok schema: type: object required: – pdfBase64 properties: pdfBase64: type: string description: Relatório PDF em base 64 default: description: Error response schema: #/definitions/genericError get: description: Gera o relatório de contagem no formado PDF (codificado em base64) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresa in: query required: true type: integer format: int64 – name: filial in: query required: true type: integer format: int64 – name: dataInventario in: query required: true type: string format: date – name: deposito in: query required: true type: string – name: numeroContagem in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – pdfBase64 properties: pdfBase64: type: string description: Relatório PDF em base 64 default: description: Error response schema: #/definitions/genericError /inv_inventario/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: 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 in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /inv_inventario/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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 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: PUBLIC 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 default: description: Error response schema: #/definitions/genericError /inv_inventario/actions/gerarInventario: post: description: Geração da inicialização do inventário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – filial – deposito – dataInventario – tipoDeposito – controlaLoteSerie properties: empresa: type: integer format: int64 description: Empresa filial: type: integer format: int64 description: Filial deposito: type: string description: Depósito dataInventario: type: string format: date description: Data do inventário tipoDeposito: type: integer format: int64 description: Tipo de depósito controlaLoteSerie: type: boolean description: Indicativo se controla lote/série lote: type: string description: Lote bloqueiaMovimentacao: type: boolean description: Indicativo se bloqueia movimento saldoProdutos: type: integer format: int64 description: Valores para saldoProdutos: 0=com estoque 1=sem estoque 2=todos grupoEstoque: type: string description: Grupo de estoque tipoProduto: type: string description: Tipo de produto origem: type: string description: Origem familia: type: string description: Família produto: type: string description: Produto derivacao: type: string description: Derivação situacaoEstoque: type: string description: Situação do estoque situacaoProduto: type: string description: Situação do produto situacaoDerivacao: type: string description: Situação da derivação curvaABC: type: string description: Curva ABC ultimoMovimento: type: string format: date description: Último movimento ultimoInventario: type: string format: date description: Último inventário fabricante: type: string description: Fabricante enderecamento: type: string description: Endereçamento enderecamentoProduto: type: string description: Endereçamento do produto enderecamentoDeposito: type: string description: Endereçamento do depósito qualidadeProduto: type: string description: Qualidade do produto responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/actions/estornarInventario: post: description: Estorno do inventário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – filial – dataInventario – deposito properties: empresa: type: integer format: int64 description: Empresa filial: type: integer format: int64 description: Filial dataInventario: type: string format: date description: Data do inventário deposito: type: string description: Depósito enderecamentoProduto: type: string description: Endereçamento do produto enderecamentoDeposito: type: string description: Endereçamento do deposito responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/actions/gerarAcertoInventario: post: description: Finaliza individualmente e gera acerto dos itens de um inventário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – filial – produto – derivacao – deposito – dataInventario – modalidade properties: empresa: type: integer format: int64 description: Empresa filial: type: integer format: int64 description: Filial produto: type: string description: Produto derivacao: type: string description: Derivação deposito: type: string description: Depósito dataInventario: type: string format: date description: Data do inventário lote: type: string description: Lote serie: type: string description: Série numeroContagem: type: integer format: int64 description: Número da contagem sequenciaContagem: type: integer format: int64 description: Sequência da contagem para fins de controle multiusuário (informar aqui o mesmo valor retornado na primitiva retornarProdutosParaFinalizacao) valorMovimento: type: number format: double description: Valor do movimento centroDeCusto: type: string description: Centro de custo contaReduzida: type: integer format: int64 description: Conta reduzida contaFinanceira: type: integer format: int64 description: Conta financeira motivo: type: integer format: int64 description: Código do motivo do acerto percentualTolerancia: type: number format: double description: Margem de tolerância da diferença dos estoques a considerar para realizar o acerto transacaoEntrada: type: string description: Código da transação para movimento de entrada no estoque transacaoSaida: type: string description: Código da transação para movimento de saída no estoque gerarNotaFiscalAcerto: type: boolean description: Gerar nota fiscal ao invés de movimento de estoque (opção apenas para empresas agronegócio) modalidade: type: integer format: int64 description: Valores para modalidade: 0=sem Diferença 1=com Diferença 2=Todos c/ Acerto Est. 3=Todos s/ Acerto Est. responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/actions/salvarContagem: post: description: Persiste contagem tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – filial – dataInventario – deposito – numeroContagem – numeroDocumento – tipoInventario – item properties: empresa: type: integer format: int64 description: Empresa filial: type: integer format: int64 description: Filial dataInventario: type: string format: date description: Data do inventário deposito: type: string description: Depósito numeroContagem: type: integer format: int64 description: Número da contagem numeroDocumento: type: string description: Número do documento tipoInventario: type: string allOf: – #/definitions/enumTipoInventario description: Tipo de inventário quantidadeContagensAcertoAutomatico: type: integer format: int64 description: Quantidade de contagens necessárias para o acerto automático. Se for 0, o acerto automático não é feito modalidadeAcertoAutomatico: type: integer format: int64 description: Indicativo se gera acerto automático valorMovimento: type: number format: double description: Valor do movimento motivoAcerto: type: integer format: int64 description: Código do motivo do acerto percentualTolerancia: type: number format: double description: Margem de tolerância da diferença dos estoques a considerar para realizar o acerto item: type: object allOf: – #/definitions/recInventarioItemContado description: Item contado responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /inv_inventario/actions/inserirProdutoContagem: post: description: Insere um novo produto na contagem tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa – filial – dataInventario – deposito – produto – derivacao – saldoDosLotes properties: empresa: type: integer format: int64 description: Empresa filial: type: integer format: int64 description: Filial dataInventario: type: string format: date description: Data do inventário deposito: type: string description: Depósito produto: type: string description: Produto derivacao: type: string description: Derivação saldoDosLotes: type: string allOf: – #/definitions/enumSaldoLotes description: Saldo dos lotes responses: 200: description: Ok schema: type: object required: – iteminventario properties: iteminventario: type: object allOf: – #/definitions/recItemInventario description: Item do inventário default: description: Error response schema: #/definitions/genericError definitions: tipoCodigoBarras: description: Tipo de código de barras type: string enum: – E – L – B – O – S – V enumSaldoLotes: description: Tip de saldo de lotes type: string enum: – Todos – ApenasPositivo enumTipoInventario: description: Tipo de inventário type: string enum: – Nenhum – Normal – Rotativo userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT recDeposito: description: Estrutura de dados do depósito type: object required: – empresa – deposito – descricaoDeposito – abreviaturaDeposito properties: empresa: type: integer format: int64 description: Empresa deposito: type: string description: Depósito descricaoDeposito: type: string description: Descriação abreviaturaDeposito: type: string description: Abreviatura recInventario: description: Estrutura de dados do inventário type: object required: – empresa – dataInventario – deposito – loteSerie – ultimaContagem – contagensAcerto properties: empresa: type: integer format: int64 description: Empresa dataInventario: type: string format: date description: Data do inventário deposito: type: string description: Depósito loteSerie: type: string description: Lote/série ultimaContagem: type: integer format: int64 description: Última contagem contagensAcerto: type: integer format: int64 description: Contages acerto recLote: description: Estrutura de dados do lote type: object required: – empresa – produto – derivacao – deposito – numeroSerie – lote properties: empresa: type: integer format: int64 description: Empresa produto: type: string description: Produto derivacao: type: string description: Derivação deposito: type: string description: Depósito numeroSerie: type: string description: Número de série lote: type: string description: Lote recGrupoEstoque: description: Estrutura de dados do agrupamento de estoque type: object required: – empresa – grupoEstoque – descricaoGrupo – abreviaturaGrupo properties: empresa: type: integer format: int64 description: Empresa grupoEstoque: type: string description: Grupo de estoque descricaoGrupo: type: string description: Descriação abreviaturaGrupo: type: string description: Abreviatura recEnumerado: description: Estrutura de tipos enumerados type: object required: – valor – descricao properties: valor: type: string description: Valor descricao: type: string description: Descriação recOrigem: description: Estrutura de dados da origem type: object required: – empresa – origem – descricaoOrigem – nivelOrigem properties: empresa: type: integer format: int64 description: Empresa origem: type: string description: Origem descricaoOrigem: type: string description: Descriação nivelOrigem: type: integer format: int64 description: Nível recFamilia: description: Estrutura de dados da família type: object required: – empresa – familia – descricaoFamilia properties: empresa: type: integer format: int64 description: Empresa familia: type: string description: Família descricaoFamilia: type: string description: Descrição recProduto: description: Estrutura de dados do produtos type: object required: – empresa – produto – descricaoProduto properties: empresa: type: integer format: int64 description: Empresa produto: type: string description: Produto descricaoProduto: type: string description: Descrição recDerivacao: description: Estrutura de dados da derivação type: object required: – empresa – produto – derivacao – descricaoDerivacao – descricaoComplementar properties: empresa: type: integer format: int64 description: Empresa produto: type: string description: Produto derivacao: type: string description: Derivação descricaoDerivacao: type: string description: Descrição descricaoComplementar: type: string description: Complemento recFabricante: description: Estrutura de dados do fabricante type: object required: – empresa – produto – derivacao – fabricante – fornecedor – produtoFabricante – descricaoProdutoFabricante properties: empresa: type: integer format: int64 description: Empresa produto: type: string description: Produto derivacao: type: string description: Derivação fabricante: type: string description: Fabricante fornecedor: type: integer format: int64 description: Fornecedor produtoFabricante: type: string description: Produto no fabricante descricaoProdutoFabricante: type: string description: Descrição do produto no fabricante recEnderecamento: description: Estrutura de dados do endereçamento type: object required: – empresa – endereco – descricaoEndereco – familia properties: empresa: type: integer format: int64 description: Empresa endereco: type: string description: Endereçamento descricaoEndereco: type: string description: Descrição familia: type: string description: Família recContaReduzida: description: Estrutura de dados da conta reduzida type: object required: – empresa – contaReduzida – descricaoConta – abreviaturaConta properties: empresa: type: integer format: int64 description: Empresa contaReduzida: type: integer format: int64 description: Conta reduzida descricaoConta: type: string description: Descricao abreviaturaConta: type: string description: Abreviatura recContaFinanceira: description: Estrutura de dados da conta financeira type: object required: – empresa – contaFinanceira – descricaoConta – abreviaturaConta properties: empresa: type: integer format: int64 description: Empresa contaFinanceira: type: integer format: int64 description: Conta financeira descricaoConta: type: string description: Descrição abreviaturaConta: type: string description: Abreviatura recCentroDeCusto: description: Estrutura de dados do centro de custo type: object required: – empresa – centroDeCusto – descricaoCentroDeCusto – abreviaturaCentroDeCusto properties: empresa: type: integer format: int64 description: Empresa centroDeCusto: type: string description: Centro de custo descricaoCentroDeCusto: type: string description: Descrição abreviaturaCentroDeCusto: type: string description: Abreviatura recTransacao: description: Estrutura de dados da transação type: object required: – empresa – transacao – descricaoTransacao – entradaOuSaida properties: empresa: type: integer format: int64 description: Empresa transacao: type: string description: Transação descricaoTransacao: type: string description: Descrição entradaOuSaida: type: string description: Indicativo se (E)entrada ou (S)saída recMotivo: description: Estrutura de dados dos motivos type: object required: – motivo – descricaoMotivo properties: motivo: type: integer format: int64 description: Motivo descricaoMotivo: type: string description: Descrição recParamInventario: description: Estrutura de dados dos parâmetros do inventário type: object required: – empresa – dataInventario – deposito – controlaLoteSerie – bloqueiaMovimentacao properties: empresa: type: integer format: int64 description: Empresa dataInventario: type: string format: date description: Data do inventário deposito: type: string description: Depósito controlaLoteSerie: type: boolean description: Indicativo se controla lote/série bloqueiaMovimentacao: type: boolean description: Indicativo se bloqueia movimento recLotesParaFinalizacao: description: Estrutura de lote/série para finalização do inventário type: object required: – empresa – produto – derivacao – quantidadeEstoque – quantidadeContagem properties: empresa: type: integer format: int64 description: Empresa produto: type: string description: Produto derivacao: type: string description: Derivação lote: type: string description: Lote serie: type: string description: Série dataValidade: type: string format: date description: Data de validade dataFabricacao: type: string format: date description: Data de fabricação quantidadeEstoque: type: number format: double description: Quantidade em estoque quantidadeContagem: type: number format: double description: Quantidade da contagem recProdutosParaFinalizacao: description: Estrutura de dados da lista de produtos para finalização e acerto type: object required: – empresa – dataInventario – deposito – produto – derivacao – produtoControladoPorLote – produtoControladoPorSerie – indicativoInventario – situacaoEstoque – quantidadeContagem – quantidadeEstoque – quantidadeDiferenca – precoMedio – unidadeMedida – indicativoDiferenca – numeroContagem – sequenciaContagem – descricaoProduto – transacaoEntrada – transacaoSaida – inventarioRotativo – modalidadeAcerto – lotes properties: empresa: type: integer format: int64 description: Empresa dataInventario: type: string format: date description: Data do inventário deposito: type: string description: Depósito produto: type: string description: Produto derivacao: type: string description: Derivação produtoControladoPorLote: type: boolean description: Indicativo se produto controlado por lote produtoControladoPorSerie: type: boolean description: Indicativo se produto controlado por série indicativoInventario: type: integer format: int64 description: Indicativo se está em inventário situacaoEstoque: type: string description: Situação do estoque quantidadeContagem: type: number format: double description: Quantidade da contagem quantidadeEstoque: type: number format: double description: Quantidade em estoque quantidadeDiferenca: type: number format: double description: Quantidade da diferença precoMedio: type: number format: double description: Preço médio unidadeMedida: type: string description: Unidade de medida indicativoDiferenca: type: boolean description: Indicativo de diferença numeroContagem: type: integer format: int64 description: Número da contagem sequenciaContagem: type: integer format: int64 description: Sequência da contagem descricaoProduto: type: string description: Descrição do produto transacaoEntrada: type: string description: Transação de entrada transacaoSaida: type: string description: Transação de saída inventarioRotativo: type: boolean description: Indicativo se inventário rotativo modalidadeAcerto: type: string description: Modalidade de acerto lotes: type: array items: type: object allOf: – #/definitions/recLotesParaFinalizacao minimum: 1 description: Lotes recParametrosContagem: description: Estrutura de dados da contagem do inventário type: object required: – empresa – dataInventario – deposito – ultimaContagem – proximaContagem – contagensAcerto – tipoContagem properties: empresa: type: integer format: int64 description: Empresa dataInventario: type: string format: date description: Data do inventário deposito: type: string description: Depósito ultimaContagem: type: integer format: int64 description: Última contagem proximaContagem: type: integer format: int64 description: Próxima contagem contagensAcerto: type: integer format: int64 description: Contages de acerto tipoContagem: type: string allOf: – #/definitions/enumTipoInventario description: Tipo da contagem recInventarioContagemItemLote: description: Estrutura de dados de lotes da contagem do inventário type: object required: – produto – derivacao – serie – lote – quantidadeContagem properties: produto: type: string description: Produto derivacao: type: string description: Derivação serie: type: string description: Série lote: type: string description: Lote quantidadeContagem: type: number format: double description: Quantidade da contagem dataFabricacao: type: string format: date description: Data de fabricação dataValidade: type: string format: date description: Data de validade quantidadeEstoque: type: number format: double description: Quantidade em estoque recInventarioItemContado: description: Estrutura do item contado type: object required: – produto – derivacao – unidadeMedida – quantidadeContagem – dataHoraContagem – sequenciaContagem properties: produto: type: string description: Produto derivacao: type: string description: Derivação unidadeMedida: type: string description: Unidade de medida quantidadeContagem: type: number format: double description: Quantidade da contagem dataHoraContagem: type: string format: date-time description: Data/hora da contagem sequenciaContagem: type: integer format: int64 description: Sequência da contagem lotes: type: array items: type: object allOf: – #/definitions/recInventarioContagemItemLote description: Lotes recInventarioContagemItem: description: Estrutura de dados dos itens da contagem do inventário type: object required: – produto – derivacao – origem – familia – descricaoProduto – unidadeMedida – controlaLote – controleSerie – quantidadeVolumes – quantidadeInicial – numeroContagem – sequenciaContagem – quantidadeContagem – quantidadeUltimaContagem – dataHoraUltimaContagem – usuarioContagem – usuarioUltimaContagem – nomeUsuarioContagem – nomeUsuarioUltimaContagem – precoMedio – lotes properties: produto: type: string description: Produto derivacao: type: string description: Derivação origem: type: string description: Origem familia: type: string description: Família descricaoProduto: type: string description: Descrição do produto unidadeMedida: type: string description: Unidade de medida controlaLote: type: boolean description: Indicativo se controle lote controleSerie: type: boolean description: Indicativo se controla série quantidadeVolumes: type: integer format: int64 description: Quantidade de volumes quantidadeInicial: type: number format: double description: Quantidade inicial numeroContagem: type: integer format: int64 description: Número da contagem sequenciaContagem: type: integer format: int64 description: Sequência da contagem quantidadeContagem: type: number format: double description: Quantidade da contagem quantidadeUltimaContagem: type: number format: double description: Quantidade da última contagem dataHoraUltimaContagem: type: string format: date-time description: Data/hora da última contagem usuarioContagem: type: integer format: int64 description: Usuário da contagem usuarioUltimaContagem: type: integer format: int64 description: Usuário da última contagem nomeUsuarioContagem: type: string description: Nome do usuário da contagem nomeUsuarioUltimaContagem: type: string description: Nome do usuário da última contagem precoMedio: type: number format: double description: Preço médio lotes: type: array items: type: object allOf: – #/definitions/recInventarioContagemItemLote minimum: 1 description: Lotes recItemInventario: description: Estrutura de dados dos itens da contagem do inventário type: object required: – itens properties: itens: type: array items: type: object allOf: – #/definitions/recInventarioContagemItem minimum: 1 description: Itens notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: 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 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 description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE