erp_est

doc_movdocumento

26 views 22/10/2018 integrador 0

2.0info: 1.11.1 doc_movdocumento description: Estoque – Movimentação do documento x-senior-domain: erp_est x-senior-domain-path: erp_est x-senior-service-path: doc_movdocumento 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_estsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /doc_movdocumento/queries/pesquisarDocumento: post: description: consultar os documento inseridos, poderá retornar mais de um documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – paginacao properties: filtro: type: object allOf: – #/definitions/recFiltroPesquisarDocumento description: Filtro paginacao: type: object allOf: – #/definitions/recPaginacao description: Paginação responses: 200: description: Ok schema: type: object required: – paginacaoRetorno properties: documento: type: array items: type: object allOf: – #/definitions/recDocumento description: irá retornar um lista com os documentos encontrados conforme os filtros, e seus respectivos SKUs paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: retorno paginação default: description: Error response schema: #/definitions/genericError get: description: consultar os documento inseridos, poderá retornar mais de um documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: filtro in: query type: object allOf: – #/definitions/recFiltroPesquisarDocumento – name: paginacao in: query required: true type: object allOf: – #/definitions/recPaginacao responses: 200: description: Ok schema: type: object required: – paginacaoRetorno properties: documento: type: array items: type: object allOf: – #/definitions/recDocumento description: irá retornar um lista com os documentos encontrados conforme os filtros, e seus respectivos SKUs paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: retorno paginação default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/pesquisarDocumentoOrigem: post: description: consultar as origens dos documentos inseridos, poderá retornar mais de uma origem tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – paginacao properties: ids: type: array items: type: integer format: int64 description: lista de id de identificação das origens descricao: type: string description: descrição das origens paginacao: type: object allOf: – #/definitions/recPaginacao description: Paginação responses: 200: description: Ok schema: type: object required: – paginacaoRetorno properties: documento: type: array items: type: object allOf: – #/definitions/recDocumentoOrigem description: irá retornar um lista com as origens dos documentos encontrados conforme os filtros paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: retorno paginação default: description: Error response schema: #/definitions/genericError get: description: consultar as origens dos documentos inseridos, poderá retornar mais de uma origem tags: – Queries x-senior-visibility: PUBLIC parameters: – name: ids in: query type: array items: type: integer format: int64 – name: descricao in: query type: string – name: paginacao in: query required: true type: object allOf: – #/definitions/recPaginacao responses: 200: description: Ok schema: type: object required: – paginacaoRetorno properties: documento: type: array items: type: object allOf: – #/definitions/recDocumentoOrigem description: irá retornar um lista com as origens dos documentos encontrados conforme os filtros paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: retorno paginação default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/pesquisarSKU: post: description: consultar os SKUs inseridos, poderá retornar mais de um SKU tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – paginacao properties: codigoEmpresa: type: integer format: int64 description: código da empresa ids: type: array items: type: integer format: int64 description: (opcional) – lista de id de identificação de SKU codigo: type: string description: (opcional) – código do SKU descricao: type: string description: (opcional) – descrição do SKU familiaCodigo: type: array items: type: string description: código da família do SKU paginacao: type: object allOf: – #/definitions/recPaginacao description: Paginação responses: 200: description: Ok schema: type: object required: – paginacaoRetorno properties: skus: type: array items: type: object allOf: – #/definitions/recSKU description: lista com os SKUs encontrados conforme os filtros paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: retorno paginação default: description: Error response schema: #/definitions/genericError get: description: consultar os SKUs inseridos, poderá retornar mais de um SKU tags: – Queries x-senior-visibility: PUBLIC parameters: – name: codigoEmpresa in: query required: true type: integer format: int64 – name: ids in: query type: array items: type: integer format: int64 – name: codigo in: query type: string – name: descricao in: query type: string – name: familiaCodigo in: query type: array items: type: string – name: paginacao in: query required: true type: object allOf: – #/definitions/recPaginacao responses: 200: description: Ok schema: type: object required: – paginacaoRetorno properties: skus: type: array items: type: object allOf: – #/definitions/recSKU description: lista com os SKUs encontrados conforme os filtros paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: retorno paginação default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/pesquisarDeposito: post: description: consultar os depósito inseridos, poderá retornar mais de um depósito tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoFilial properties: codigoEmpresa: type: integer format: int64 description: código da empresa codigoFilial: type: integer format: int64 description: código da filial ids: type: array items: type: integer format: int64 description: (opcional) – lista de id de identificação do depósito codigo: type: string description: (opcional) – código do depósito descricao: type: string description: (opcional) – descrição do depósito situacao: type: string allOf: – #/definitions/enumSituacaoDeposito description: (opcional) – situação do depósito responses: 200: description: Ok schema: type: object properties: depositos: type: array items: type: object allOf: – #/definitions/recDeposito description: lista com os depósitos encontrados conforme os filtros default: description: Error response schema: #/definitions/genericError get: description: consultar os depósito inseridos, poderá retornar mais de um depósito tags: – Queries x-senior-visibility: PUBLIC parameters: – name: codigoEmpresa in: query required: true type: integer format: int64 – name: codigoFilial in: query required: true type: integer format: int64 – name: ids in: query type: array items: type: integer format: int64 – name: codigo in: query type: string – name: descricao in: query type: string – name: situacao in: query type: string allOf: – #/definitions/enumSituacaoDeposito responses: 200: description: Ok schema: type: object properties: depositos: type: array items: type: object allOf: – #/definitions/recDeposito description: lista com os depósitos encontrados conforme os filtros default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/pesquisarDepositoSKU: post: description: Consulta as configurações de depósito x SKU tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – empresaCodigo – filialCodigos – paginacao properties: empresaCodigo: type: integer format: int64 description: Empresa da configuração dos depósitos filialCodigos: type: array items: type: integer format: int64 minimum: 1 description: Filial da configuração dos depósitos documentoOrigemId: type: integer format: int64 description: Identificador único da origem skuId: type: integer format: int64 description: Identificador único do SKU depositoId: type: integer format: int64 description: Identificador único do depósito familiasIds: type: array items: type: integer format: int64 description: Família da configuração dos depósitos paginacao: type: object allOf: – #/definitions/recPaginacao description: Paginação responses: 200: description: Ok schema: type: object required: – paginacaoRetorno properties: depositoSKUs: type: array items: type: object allOf: – #/definitions/depositoSku description: Lista com as configurações de depósitos encontrados conforme os filtros paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: retorno paginação default: description: Error response schema: #/definitions/genericError get: description: Consulta as configurações de depósito x SKU tags: – Queries x-senior-visibility: PUBLIC parameters: – name: empresaCodigo in: query required: true type: integer format: int64 – name: filialCodigos in: query required: true type: array items: type: integer format: int64 minimum: 1 – name: documentoOrigemId in: query type: integer format: int64 – name: skuId in: query type: integer format: int64 – name: depositoId in: query type: integer format: int64 – name: familiasIds in: query type: array items: type: integer format: int64 – name: paginacao in: query required: true type: object allOf: – #/definitions/recPaginacao responses: 200: description: Ok schema: type: object required: – paginacaoRetorno properties: depositoSKUs: type: array items: type: object allOf: – #/definitions/depositoSku description: Lista com as configurações de depósitos encontrados conforme os filtros paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: retorno paginação default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/pesquisarSaldosEstoque: post: description: Pesquisar o saldo de estoque de um produto tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoSKU – documentoOrigemDescricao properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Opcional – Código da filial codigoDeposito: type: string description: Código do depósito codigoSKU: type: string description: Código do SKU documentoOrigemDescricao: type: string description: Descrição do documento de origem lote: type: string maxLength: 50 description: Código do lote serie: type: string maxLength: 50 description: Número da série responses: 200: description: Ok schema: type: object required: – saldosEstoque properties: saldosEstoque: type: array items: type: object allOf: – #/definitions/recSaldosEstoque minimum: 1 description: saldos do estoque do produto encontrado conforme os filtros default: description: Error response schema: #/definitions/genericError get: description: Pesquisar o saldo de estoque de um produto tags: – Queries x-senior-visibility: PUBLIC parameters: – name: codigoEmpresa in: query required: true type: integer format: int64 – name: codigoFilial in: query type: integer format: int64 – name: codigoDeposito in: query type: string – name: codigoSKU in: query required: true type: string – name: documentoOrigemDescricao in: query required: true type: string – name: lote in: query type: string maxLength: 50 – name: serie in: query type: string maxLength: 50 responses: 200: description: Ok schema: type: object required: – saldosEstoque properties: saldosEstoque: type: array items: type: object allOf: – #/definitions/recSaldosEstoque minimum: 1 description: saldos do estoque do produto encontrado conforme os filtros default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/pesquisarSaldosEstoqueComPaginacao: post: description: Pesquisar o saldo de estoque de um produto com paginação tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoSKU – paginacao properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Opcional – Código da filial codigoDeposito: type: string description: Código do depósito codigoSKU: type: string description: Código do SKU lote: type: string maxLength: 50 description: Código do lote serie: type: string maxLength: 50 description: Número da série paginacao: type: object allOf: – #/definitions/recPaginacao description: Dados de paginação responses: 200: description: Ok schema: type: object required: – saldosEstoque – paginacaoRetorno properties: saldosEstoque: type: array items: type: object allOf: – #/definitions/recSaldosEstoque minimum: 1 description: saldos do estoque do produto encontrado conforme os filtros paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: Dados de retorno da paginação default: description: Error response schema: #/definitions/genericError get: description: Pesquisar o saldo de estoque de um produto com paginação tags: – Queries x-senior-visibility: PUBLIC parameters: – name: codigoEmpresa in: query required: true type: integer format: int64 – name: codigoFilial in: query type: integer format: int64 – name: codigoDeposito in: query type: string – name: codigoSKU in: query required: true type: string – name: lote in: query type: string maxLength: 50 – name: serie in: query type: string maxLength: 50 – name: paginacao in: query required: true type: object allOf: – #/definitions/recPaginacao responses: 200: description: Ok schema: type: object required: – saldosEstoque – paginacaoRetorno properties: saldosEstoque: type: array items: type: object allOf: – #/definitions/recSaldosEstoque minimum: 1 description: saldos do estoque do produto encontrado conforme os filtros paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: Dados de retorno da paginação default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/pesquisarSaldosEstoqueSkus: post: description: Pesquisa o saldo de estoque de um conjunto de produtos de forma sincrona tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – parametros properties: parametros: type: array items: type: object allOf: – #/definitions/recParametrosSaldoEstoque minimum: 1 description: Parâmetros da pesquisa da consulta de estoques responses: 200: description: Ok schema: type: object required: – saldosEstoque properties: saldosEstoque: type: array items: type: object allOf: – #/definitions/recSaldosEstoqueSkus minimum: 1 description: Saldos de estoque encontrado para os SKUs fornecidos default: description: Error response schema: #/definitions/genericError get: description: Pesquisa o saldo de estoque de um conjunto de produtos de forma sincrona tags: – Queries x-senior-visibility: PUBLIC parameters: – name: parametros in: query required: true type: array items: type: object allOf: – #/definitions/recParametrosSaldoEstoque minimum: 1 responses: 200: description: Ok schema: type: object required: – saldosEstoque properties: saldosEstoque: type: array items: type: object allOf: – #/definitions/recSaldosEstoqueSkus minimum: 1 description: Saldos de estoque encontrado para os SKUs fornecidos default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/pesquisarFamilia: post: description: retorna a lista de famílias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaCodigo properties: empresaCodigo: type: integer format: int64 description: empresa da família filtro: type: string description: permite filtro pelos campos de código ou descrição tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicao description: Tipo de reposição responses: 200: description: Ok schema: type: object required: – familias properties: familias: type: array items: type: object allOf: – #/definitions/recFamilia minimum: 1 description: Retorno contendo registros de famílias default: description: Error response schema: #/definitions/genericError get: description: retorna a lista de famílias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaCodigo in: query required: true type: integer format: int64 – name: filtro in: query type: string – name: tipoReposicao in: query type: string allOf: – #/definitions/enumTipoReposicao responses: 200: description: Ok schema: type: object required: – familias properties: familias: type: array items: type: object allOf: – #/definitions/recFamilia minimum: 1 description: Retorno contendo registros de famílias default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/pesquisarDocumentoAtendimentoManual: post: description: retorna uma lista de documentos que necessitam de atendimento manual tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – paginacao properties: codigo: type: string description: Código do documento descricao: type: string description: descrição do documento documentoOrigemId: type: integer format: int64 description: documento de origem skuId: type: integer format: int64 description: sku vinculado ao documento empresaId: type: integer format: int64 description: Código de empresa filialId: type: integer format: int64 description: Código de filial familiasIds: type: array items: type: integer format: int64 description: Códigos de famílias paginacao: type: object allOf: – #/definitions/recPaginacao description: paginação responses: 200: description: Ok schema: type: object required: – documentosAtendimentoManual – paginacaoRetorno properties: documentosAtendimentoManual: type: array items: type: object allOf: – #/definitions/documentoAtendimentoManual minimum: 1 description: entidade documentoAtendimentoManual paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: retorno paginação default: description: Error response schema: #/definitions/genericError get: description: retorna uma lista de documentos que necessitam de atendimento manual tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigo in: query type: string – name: descricao in: query type: string – name: documentoOrigemId in: query type: integer format: int64 – name: skuId in: query type: integer format: int64 – name: empresaId in: query type: integer format: int64 – name: filialId in: query type: integer format: int64 – name: familiasIds in: query type: array items: type: integer format: int64 – name: paginacao in: query required: true type: object allOf: – #/definitions/recPaginacao responses: 200: description: Ok schema: type: object required: – documentosAtendimentoManual – paginacaoRetorno properties: documentosAtendimentoManual: type: array items: type: object allOf: – #/definitions/documentoAtendimentoManual minimum: 1 description: entidade documentoAtendimentoManual paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: retorno paginação default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/pesquisarPessoa: post: description: Realiza a pesquisa de pessoas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipo – paginacao properties: tipo: type: string allOf: – #/definitions/enumTipoPessoa description: Enumerador do Tipo de pessoa se é EMPRESA ou FILIAL codigo: type: integer format: int64 description: código da empresa nome: type: string description: Nome da empresa fantasia: type: string description: Nome fantasia da empresa pessoaOrigemId: type: integer format: int64 description: ID da Empresa Origem pessoaOrigemCodigo: type: integer format: int64 description: Código da empresa Origem paginacao: type: object allOf: – #/definitions/recPaginacao description: Paginação da consulta responses: 200: description: Ok schema: type: object required: – recPessoa – paginacaoRetorno properties: recPessoa: type: array items: type: object allOf: – #/definitions/recPessoa minimum: 1 description: Lista de empresas paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: Retorno paginação default: description: Error response schema: #/definitions/genericError get: description: Realiza a pesquisa de pessoas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tipo in: query required: true type: string allOf: – #/definitions/enumTipoPessoa – name: codigo in: query type: integer format: int64 – name: nome in: query type: string – name: fantasia in: query type: string – name: pessoaOrigemId in: query type: integer format: int64 – name: pessoaOrigemCodigo in: query type: integer format: int64 – name: paginacao in: query required: true type: object allOf: – #/definitions/recPaginacao responses: 200: description: Ok schema: type: object required: – recPessoa – paginacaoRetorno properties: recPessoa: type: array items: type: object allOf: – #/definitions/recPessoa minimum: 1 description: Lista de empresas paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: Retorno paginação default: description: Error response schema: #/definitions/genericError /doc_movdocumento/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 /doc_movdocumento/queries/exportDepositoSku: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/exportDeposito: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/exportDocumentoOrigem: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/exportSku: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/exportDocumentoAtendimentoManual: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/exportEmpresa: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/exportFamilia: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/exportParametrosConsumo: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/exportPessoa: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/queries/exportUnidadeMedida: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/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 /doc_movdocumento/actions/processarDocumento: post: description: quando for processado/aceito o documento pelo estoque, essa primitiva irá alterar a situação do documento de Recebido para Em movimentação, o deixando apto para movimentar estoque tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ids properties: ids: type: array items: type: integer format: int64 minimum: 1 description: ids dos documentos na tabela responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: boolean description: Retorno default: description: Error response schema: #/definitions/genericError /doc_movdocumento/actions/rejeitarDocumento: post: description: quando for rejeitado o documento pelo estoque, essa primitiva irá alterar a situação do documento de Recebido para Rejeitado e não irá realizar a movimentação de estoque tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ids properties: ids: type: array items: type: integer format: int64 minimum: 1 description: ids dos documentos na tabela responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: boolean description: Retorno default: description: Error response schema: #/definitions/genericError /doc_movdocumento/actions/cancelarMovimentacaoDocumento: post: description: quando não ocorrer a movimentação de estoque por qualquer motivo, essa primitiva irá alterar a situação do documento de Em movimentação para Recebido tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – observacao properties: id: type: integer format: int64 description: id do documento na tabela observacao: type: string description: observação / motivo do cancelamento responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: boolean description: Retorno default: description: Error response schema: #/definitions/genericError /doc_movdocumento/actions/sugerirLoteSerieDocumento: post: description: primitiva responsável pela sugestão de numeração de lote e série de acordo com as máscaras do cadastro de sku tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoSku – ordemProducaoId – codigoFabricante properties: codigoEmpresa: type: integer format: int64 description: Código da empresa da op codigoSku: type: string description: Código do sku ordemProducaoId: type: integer format: int64 description: código/id da OP codigoFabricante: type: string description: normalmente utilizado para código de barras EAN13 ou código livre associado ao cadastro do SKU responses: 200: description: Ok schema: type: object required: – documento properties: documento: type: object allOf: – #/definitions/recMascaraLoteSerie description: Retorno contendo registros de lotes e séries default: description: Error response schema: #/definitions/genericError /doc_movdocumento/actions/cancelarDocumento: post: description: Realiza o cancelamento do documento a partir da origem e do código tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – origem – codigo properties: origem: type: string description: origem da inserção do documento de movimentação de estoque, ex: apontamento manufatura, cancelamento manufatura… codigo: type: string description: código único de identificação do documento, cada serviço que irá chamar esse primitiva poderá montar o seu código responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: boolean description: Retorno default: description: Error response schema: #/definitions/genericError /doc_movdocumento/actions/importDepositoSku: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/actions/importDeposito: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/actions/importDocumentoOrigem: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/actions/importSku: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/actions/importDocumentoAtendimentoManual: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/actions/importEmpresa: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/actions/importFamilia: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/actions/importParametrosConsumo: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/actions/importPessoa: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/actions/importUnidadeMedida: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /doc_movdocumento/signals/inserirDocumento: post: description: inserir um documento para realizar uma movimentação no estoque de entrada ou saída, toda movimentação de estoque será realizada a partir desse documento tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoFilial – origem – codigo – tipoMovimento – documentoSKUs properties: codigoEmpresa: type: integer format: int64 description: código da empresa, onde será movimentado o estoque codigoFilial: type: integer format: int64 description: código da filial, onde será movimentado o estoque, conforme empresa informada origem: type: string description: origem da inserção do documento de movimentação de estoque, ex: apontamento manufatura, cancelamento manufatura… codigo: type: string description: código único de identificação do documento, cada serviço que irá chamar esse primitiva poderá montar o seu código tipoMovimento: type: string allOf: – #/definitions/enumTipoMovimentoDocumento description: tipo do movimento do documento, entrada ou saída numeroDocumentoMovimento: type: integer format: int64 description: número do documento que será registrado da tabela de movimento da G5 observacao: type: string description: observação para o documento tipoDocumento: type: string allOf: – #/definitions/enumTipoDocumento description: tipo de documento, produto ou reserva, quando não for informado nada, será assumido produto documentoSKUs: type: array items: type: object allOf: – #/definitions/recDocumentoSKUInsert minimum: 1 description: Dados do(s) SKU(s) que serão movimentados responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /doc_movdocumento/signals/movimentarDocumento: post: description: quando for efetivada a movimentação de estoque, essa primitiva irá alterar a situação do documento de Em movimentação para Movimentado tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: id do documento na tabela responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/depositoSku: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/depositoSku responses: 200: description: The created resource schema: #/definitions/depositoSku default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/depositoSku responses: 200: description: The created resource schema: #/definitions/depositoSku default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/depositoSku default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/depositoSku/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/depositoSku responses: 200: description: Ok schema: #/definitions/depositoSku default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/depositoSku responses: 200: description: Ok schema: #/definitions/depositoSku default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/depositoSku default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/depositoSku/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/depositoSku responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/deposito: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/deposito responses: 200: description: The created resource schema: #/definitions/deposito default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/deposito responses: 200: description: The created resource schema: #/definitions/deposito default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/deposito default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/deposito/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/deposito responses: 200: description: Ok schema: #/definitions/deposito default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/deposito responses: 200: description: Ok schema: #/definitions/deposito default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/deposito default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/deposito/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/deposito responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/documentoOrigem: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentoOrigem responses: 200: description: The created resource schema: #/definitions/documentoOrigem default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentoOrigem responses: 200: description: The created resource schema: #/definitions/documentoOrigem default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/documentoOrigem default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/documentoOrigem/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentoOrigem responses: 200: description: Ok schema: #/definitions/documentoOrigem default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentoOrigem responses: 200: description: Ok schema: #/definitions/documentoOrigem default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/documentoOrigem default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/documentoOrigem/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/documentoOrigem responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/sku: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/sku responses: 200: description: The created resource schema: #/definitions/sku default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/sku responses: 200: description: The created resource schema: #/definitions/sku default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/sku default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/sku/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sku responses: 200: description: Ok schema: #/definitions/sku default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sku responses: 200: description: Ok schema: #/definitions/sku default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/sku default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/sku/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/sku responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/documentoAtendimentoManual: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentoAtendimentoManual responses: 200: description: The created resource schema: #/definitions/documentoAtendimentoManual default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentoAtendimentoManual responses: 200: description: The created resource schema: #/definitions/documentoAtendimentoManual default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/documentoAtendimentoManual default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/documentoAtendimentoManual/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentoAtendimentoManual responses: 200: description: Ok schema: #/definitions/documentoAtendimentoManual default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentoAtendimentoManual responses: 200: description: Ok schema: #/definitions/documentoAtendimentoManual default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/documentoAtendimentoManual default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/documentoAtendimentoManual/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/documentoAtendimentoManual responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/empresa: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/empresa responses: 200: description: The created resource schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/empresa responses: 200: description: The created resource schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/empresa default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/empresa/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/empresa responses: 200: description: Ok schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/empresa responses: 200: description: Ok schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/empresa/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/empresa responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/familia: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/familia responses: 200: description: The created resource schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/familia responses: 200: description: The created resource schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/familia default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/familia/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/familia responses: 200: description: Ok schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/familia responses: 200: description: Ok schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/familia/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/familia responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/parametrosConsumo: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/parametrosConsumo responses: 200: description: The created resource schema: #/definitions/parametrosConsumo default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/parametrosConsumo responses: 200: description: The created resource schema: #/definitions/parametrosConsumo default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/parametrosConsumo default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/parametrosConsumo/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/parametrosConsumo responses: 200: description: Ok schema: #/definitions/parametrosConsumo default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/parametrosConsumo responses: 200: description: Ok schema: #/definitions/parametrosConsumo default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/parametrosConsumo default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/parametrosConsumo/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/parametrosConsumo responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/pessoa: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/pessoa responses: 200: description: The created resource schema: #/definitions/pessoa default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/pessoa responses: 200: description: The created resource schema: #/definitions/pessoa default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/pessoa default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/pessoa/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pessoa responses: 200: description: Ok schema: #/definitions/pessoa default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pessoa responses: 200: description: Ok schema: #/definitions/pessoa default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pessoa default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/pessoa/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/pessoa responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/unidadeMedida: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/unidadeMedida responses: 200: description: The created resource schema: #/definitions/unidadeMedida default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/unidadeMedida responses: 200: description: The created resource schema: #/definitions/unidadeMedida default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/unidadeMedida default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/unidadeMedida/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/unidadeMedida responses: 200: description: Ok schema: #/definitions/unidadeMedida default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/unidadeMedida responses: 200: description: Ok schema: #/definitions/unidadeMedida default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/unidadeMedida default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /doc_movdocumento/entities/unidadeMedida/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/unidadeMedida responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: enumTipoMovimentoDocumento: description: tipos de movimentações de estoque permitidas type: string enum: – Entrada – Saida enumTipoDocumento: description: tipos de documentos permitidos type: string enum: – Produto – Reserva enumSituacaoDocumento: description: Situações possíveis do documento no estoque type: string enum: – Recebido – EmMovimentacao – Movimentado – Rejeitado enumSKUSituacao: description: Situação do SKU type: string enum: – Ativo – Bloqueado – Inativo enumTipoPessoa: description: tipos de movimentações de estoque permitidas type: string enum: – EMPRESA – FILIAL enumSituacaoDeposito: description: situações dos depósitos type: string enum: – Ativo – Inativo enumTipoReposicao: description: Tipo de reposição type: string enum: – Produzido – Comprado – Servico enumTipoOrdenacao: description: Tipo de ordenação type: string enum: – Asc – Desc enumTiposConsumo: description: Tipo de consumo type: string enum: – Venda – RemessaParaIndustrializacao – TransferenciaEntreFiliais – DevolucaoDeFornecedor – Abastecimento – Compra – DevolucaoDeCliente – ApontamentoDeProducao enumTipoProduto: description: Tipo de produto type: string enum: – NaoClassificado – Mercadoria – MateriaPrima – Intermediario – Embalagem – Manufaturado – EmFabricacao – SubProduto – UsoConsumo – AtivoImobilizado – Servico – OutrosInsumos – Outros 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 fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR recDocumento: description: Campos do documento type: object required: – id – filial – documentoOrigem – codigo – tipoMovimento – situacao – documentoSKU – tipoDocumento properties: id: type: integer format: int64 description: identificador único do documento na tabela filial: type: object allOf: – #/definitions/recPessoa description: filial onde será movimentado o estoque documentoOrigem: type: object allOf: – #/definitions/recDocumentoOrigem description: origem do documento de movimentação de estoque, ex: apontamento manufatura, cancelamento manufatura… codigo: type: string description: código único de identificação do documento, cada serviço que irá chamar esse primitiva poderá montar o seu código tipoMovimento: type: string allOf: – #/definitions/enumTipoMovimentoDocumento description: tipo do movimento do documento, entrada ou saída situacao: type: string allOf: – #/definitions/enumSituacaoDocumento description: situação do documento numeroDocumentoMovimento: type: integer format: int64 description: número do documento que será registrado da tabela de movimento da G5 dataAprovacao: type: string format: date-time description: Data de aprovação documentoSKU: type: array items: type: object allOf: – #/definitions/recDocumentoSKU minimum: 1 description: Documentos de produtos dataGeracao: type: string format: date-time description: Data da geração usuarioGeracao: type: string description: Usuário geração dataProcessamento: type: string format: date-time description: Data de processamento usuarioProcessamento: type: string description: Usuário do processamento tipoDocumento: type: string allOf: – #/definitions/enumTipoDocumento description: Tipo do movimento do documento, Produto ou Reserva observacao: type: string description: Observação recDocumentoSKUInsert: description: Campos do documento_sku, para inserir o(s) SKU(s) que serão movimentados type: object required: – codigoSku – quantidade properties: codigoSku: type: string description: código do SKU quantidade: type: number format: double description: quantidade do SKU codigoDeposito: type: string maxLength: 10 description: Código do depósito loteSerie: type: array items: type: object allOf: – #/definitions/recLoteSerie description: Lote ou série documentoReservas: type: array items: type: object allOf: – #/definitions/recDocumentoReserva description: Documentos de reserva de estoque dos SKUs, utilizados somente na movimentação de saída de estoque recDocumentoReserva: description: Documentos de reservar de estoque type: object required: – origem – codigo properties: origem: type: string maxLength: 50 description: origem do documento codigo: type: string maxLength: 32 description: código do documento recSaldosEstoqueSkus: description: Contém o saldo de estoque disponível para um SKU type: object required: – codigoEmpresa – sku – qtdDisponivelFaturamento – deposito properties: codigoEmpresa: type: integer format: int64 description: Empresa sku: type: string description: Código do Produto qtdDisponivelFaturamento: type: string description: Quantidade de estoque disponível para faturamento deposito: type: string description: Código do depóstio recUnidadeMedida: description: Dados da Unidade de Medida type: object required: – id – codigo – descricao – quantidadeDecimais properties: id: type: integer format: int64 description: identificador único da unidade de medida codigo: type: string description: código da unidade de medida descricao: type: string description: descricação da unidade de medida quantidadeDecimais: type: integer format: int64 description: Quantidade de decimais recSKU: description: Registro do SKU type: object required: – id – codigo – descricao – unidadeMedidaEstoque – familiaCodigo – situacao properties: id: type: integer format: int64 description: identificador único do sku codigo: type: string description: código do sku descricao: type: string description: descrição do sku unidadeMedidaEstoque: type: object allOf: – #/definitions/recUnidadeMedida description: registro da unidade de medida do estoque familiaCodigo: type: string description: código da família do sku situacao: type: string allOf: – #/definitions/enumSKUSituacao description: situação do sku recDocumentoSKU: description: Campos do documento_sku, para identificação do(s) SKU(s) que serão movimentados type: object required: – id – sequencia – sku – idSKU – codigoSKU – quantidade properties: id: type: integer format: int64 description: identificador único do sku do documento sequencia: type: integer format: int64 description: sequencia do sku dentro do documento sku: type: object allOf: – #/definitions/recSKU description: Produto idSKU: type: integer format: int64 description: identificador único do sku codigoSKU: type: string description: código do SKU quantidade: type: number format: double description: quantidade que será movimentado do SKU conforme tipo de movimentação do documento depositos: type: array items: type: object allOf: – #/definitions/recDeposito description: Depósito loteSerie: type: array items: type: object allOf: – #/definitions/recLoteSerie description: Lote ou série documentoReservas: type: array items: type: object allOf: – #/definitions/recDocumentoReserva description: Documentos de reserva de estoque dos SKUs, utilizados somente na movimentação de saída de estoque recPessoa: description: Campos referente a tabela Pessoa type: object required: – id – tipo – codigo – fantasia – nome properties: id: type: integer format: int64 description: identificador único entidade pessoa tipo: type: string allOf: – #/definitions/enumTipoPessoa description: tipo pessoa, Empresa ou Filial codigo: type: integer format: int64 description: código da Empresa ou Filial fantasia: type: string description: nome fantasia nome: type: string description: nome empresa pessoaOrigem: type: object allOf: – #/definitions/recPessoa description: código da Empresa a qual a Filial pertence recParametrosSaldoEstoque: description: Parâmetros de pesquisa da consulta de estoque dos SKUs type: object required: – codigoEmpresa – codigoDeposito – codigoSku properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoDeposito: type: string description: Código do depósito codigoSku: type: string description: Código do SKU recDocumentoOrigem: description: Campos referente a tabela Documento Origem type: object required: – id – descricao properties: id: type: integer format: int64 description: identificador único entidade descricao: type: string description: descricao do documento de origem recDeposito: description: Campos referente a tabela de Depósitos type: object required: – id – codigo – descricao – situacao properties: id: type: integer format: int64 description: identificador único entidade codigo: type: string description: código do depósito descricao: type: string description: descricao do documento de origem situacao: type: string allOf: – #/definitions/enumSituacaoDeposito description: situação do depósito recSaldosEstoque: description: Campos referente aos saldos de estoque de um produto type: object required: – filial – deposito – sku – qtdBloqueadoManualmente – qtdConsignadaClientes – qtdConsumoMedio – qtdConsignadaFornecedores – qtdEstocagem – qtdFisicaDeposito – qtdPendente – qtdReservaExclusiva – qtdReservadoEmpenho – qtdDisponivelFaturamento – aceitaEstoqueNegativo – lotesSeries properties: filial: type: object allOf: – #/definitions/recPessoa description: Dados da filial de movimentação do estoque deposito: type: object allOf: – #/definitions/recDeposito description: Dados do depósito sku: type: object allOf: – #/definitions/recSKU description: Dados do SKU qtdBloqueadoManualmente: type: string description: Quantidade de estoque bloqueado manualmente qtdConsignadaClientes: type: string description: Quantidade consignada para clientes qtdConsumoMedio: type: string description: Quantidade de consumo médio qtdConsignadaFornecedores: type: string description: Quantidade consignada de fornecedores qtdEstocagem: type: string description: Quantidade em embalagens de estocagem do produto qtdFisicaDeposito: type: string description: Quantidade física total do estoque no depósito qtdPendente: type: string description: Quantidade pendente em ordens de produção ou compra qtdReservaExclusiva: type: string description: Quantidade de reserva exclusiva do estoque qtdReservadoEmpenho: type: string description: Quantidade do estoque reservado (empenho) qtdDisponivelFaturamento: type: string description: Quantidade de estoque disponível para faturamento aceitaEstoqueNegativo: type: boolean description: Indicativo se o estoque aceita saldo de estoque negativo lotesSeries: type: array items: type: object allOf: – #/definitions/recLoteSerieEstoque minimum: 1 description: Lista de lotes ou séries recLoteSerie: description: Campos referente a lote e série type: object required: – quantidade properties: id: type: integer format: int64 description: Identificados unico do lote ou série lote: type: string maxLength: 50 description: Código do lote serie: type: string maxLength: 50 description: Número da série quantidade: type: number format: double description: Quantidade do lote ou série (Série será sempre 1) recFamilia: description: Família type: object required: – id – codigo – descricao – empresa – tipoReposicao – controlaLote – controlaSerie properties: id: type: integer format: int64 description: Identificador único codigo: type: string description: Código da família descricao: type: string description: Descrição da família empresa: type: object allOf: – #/definitions/recPessoa description: Código da empresa tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicao description: Tipo de reposição controlaLote: type: boolean description: Indicativo se família controla lote controlaSerie: type: boolean description: Indicativo se família controla série recPaginacao: description: Dados da paginação type: object required: – pagina – numeroRegistrosPagina properties: pagina: type: integer format: int64 description: Página numeroRegistrosPagina: type: integer format: int64 description: Números de registros por páginas listaOrdenacao: type: array items: type: object allOf: – #/definitions/recListaOrdenacao description: Lista de ordenação recListaOrdenacao: description: Dados de ordenação type: object required: – campo – ordenacao properties: campo: type: string description: Campo ordenacao: type: string allOf: – #/definitions/enumTipoOrdenacao description: Tipo da ordenação recPaginacaoRetorno: description: Dados da paginação type: object required: – pagina – numeroRegistrosPagina – registrosEncontrados properties: pagina: type: integer format: int64 description: Página numeroRegistrosPagina: type: integer format: int64 description: Número de registros por página registrosEncontrados: type: integer format: int64 description: Total de registros encontrados recFiltroPesquisarDocumento: description: Filtro da pesquisa de documentos type: object required: – empresaCodigo – filialCodigos properties: ids: type: array items: type: integer format: int64 description: lista de id de identificação do documento empresaCodigo: type: integer format: int64 description: Empresa filialCodigos: type: array items: type: integer format: int64 minimum: 1 description: Filial codigos: type: array items: type: string description: lista de código único do documento situacao: type: string allOf: – #/definitions/enumSituacaoDocumento description: situação atual do documento origem: type: string description: origem do documento dataInicial: type: string format: date-time description: data de geração inicial dataFinal: type: string format: date-time description: data de geração final recMascaraLoteSerie: description: Campos referente a lote e série type: object properties: lote: type: string maxLength: 50 description: Código do lote serie: type: string maxLength: 50 description: Número da série recLoteSerieEstoque: description: Contes dados de lote e série do estoque type: object required: – serie – lote – sequencia – qtdBloqueadoManualmente – qtdEstocagem – qtdFisicaDeposito – qtdPendente – qtdReservaExclusiva – qtdReservadoEmpenho – qtdDisponivelFaturamento properties: serie: type: string maxLength: 50 description: Número de série lote: type: string maxLength: 50 description: Número do lote sequencia: type: integer format: int64 description: Seqüência de entrada do registro maximum: 9999 qtdBloqueadoManualmente: type: number format: double description: Quantidade de estoque bloqueado manualmente qtdEstocagem: type: number format: double description: Quantidade em embalagens de estocagem do produto qtdFisicaDeposito: type: number format: double description: Quantidade física total do estoque no depósito qtdPendente: type: number format: double description: Quantidade pendente em ordens de produção ou compra qtdReservaExclusiva: type: number format: double description: Quantidade de reserva exclusiva do estoque qtdReservadoEmpenho: type: number format: double description: Quantidade do estoque reservado (empenho) qtdDisponivelFaturamento: type: number format: double description: Quantidade de estoque disponível para faturamento depositoSku: description: Crud da ligação de depósito/SKU type: object required: – documentoOrigem – deposito – empresa properties: id: type: integer format: int64 description: Identificador do registro documentoOrigem: type: object allOf: – #/definitions/documentoOrigem description: documento de origem sku: type: object allOf: – #/definitions/sku description: SKU deposito: type: object allOf: – #/definitions/deposito description: Depósito que será ligado a origem do documento empresa: type: object allOf: – #/definitions/pessoa description: Empresa filial: type: object allOf: – #/definitions/pessoa description: Filial familia: type: object allOf: – #/definitions/familia description: Família usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: deposito: description: Depósito type: object required: – codigo – descricao properties: id: type: integer format: int64 description: Identificador do registro codigo: type: string maxLength: 10 description: Código do depósito descricao: type: string maxLength: 30 description: Descricao do documento de origem situacao: type: string allOf: – #/definitions/enumSituacaoDeposito description: Situação do depósito usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: documentoOrigem: description: Documento origem type: object required: – descricao properties: id: type: integer format: int64 description: Identificador do registro descricao: type: string maxLength: 50 description: Descrição usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: sku: description: Produto type: object required: – empresaId – codigo – descricao – tipoProduto – unidadeMedidaId – familiaId properties: id: type: integer format: int64 description: Identificador único do sku empresaId: type: object allOf: – #/definitions/pessoa description: Empresa a qual o produto pertence codigo: type: string maxLength: 23 description: Código do produto descricao: type: string maxLength: 100 description: Nome do produto descricaoComplementar: type: string maxLength: 150 description: Descrição do produto tipoProduto: type: string allOf: – #/definitions/enumTipoProduto description: Tipo do produto unidadeMedidaId: type: object allOf: – #/definitions/unidadeMedida description: Registro da unidade de medida do estoque situacao: type: string allOf: – #/definitions/enumSKUSituacao description: Situação do produto familiaId: type: object allOf: – #/definitions/familia description: Id da família do produto ultimoLote: type: string maxLength: 50 description: Último lote do produto ultimaSerie: type: string maxLength: 50 description: Última série do produto usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: documentoAtendimentoManual: description: Crud documento de atendimento manual type: object required: – codigo – descricao properties: id: type: string format: uuid description: identificador único codigo: type: string maxLength: 20 description: código documento descricao: type: string maxLength: 50 description: descrição documento documentoOrigem: type: object allOf: – #/definitions/documentoOrigem description: documento de origem sku: type: object allOf: – #/definitions/sku description: sku vinculado empresa: type: object allOf: – #/definitions/pessoa description: Empresa filial: type: object allOf: – #/definitions/pessoa description: Filial familia: type: object allOf: – #/definitions/familia description: Família usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: empresa: description: Empresa type: object properties: id: type: integer format: int64 description: identificador único usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: familia: description: Família type: object properties: id: type: integer format: int64 description: identificador único usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: parametrosConsumo: description: Parâmetros de consumo type: object required: – empresa – filial – familia – sku properties: id: type: string format: uuid description: identificador único empresa: type: object allOf: – #/definitions/empresa description: Empresa filial: type: object allOf: – #/definitions/empresa description: Filial familia: type: object allOf: – #/definitions/familia description: Família sku: type: object allOf: – #/definitions/sku description: Produto origem: type: string maxLength: 40 description: Origem usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: pessoa: description: Pessoa, empresa ou filial type: object required: – id – tipo – codigo – fantasia – nome properties: id: type: integer format: int64 description: identificador único entidade pessoa tipo: type: string allOf: – #/definitions/enumTipoPessoa description: tipo pessoa, Empresa ou Filial codigo: type: integer format: int64 description: código da Empresa ou Filial fantasia: type: string description: nome fantasia nome: type: string description: nome empresa pessoaOrigem: type: object allOf: – #/definitions/pessoa description: Código da Empresa a qual a Filial pertence usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: unidadeMedida: description: Dados da Unidade de Medida type: object required: – codigo – descricao – quantidadeDecimais properties: id: type: integer format: int64 description: Identificador único da unidade de medida codigo: type: string description: Código da unidade de medida descricao: type: string description: Descricação da unidade de medida quantidadeDecimais: type: integer format: int64 description: Quantidade de decimais usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: 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 blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string 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

Este artigo foi útil para você?

Leave A Comment