erp_sup

nco_necessidadecompra

97 views 12/07/2019 05/11/2019 integrador 0

2.0info: 2.4.0 nco_necessidadecompra description: Serviço de necessidade de compra x-senior-domain: erp_sup x-senior-domain-path: erp_sup x-senior-service-path: nco_necessidadecompra contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erp_supsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /nco_necessidadecompra/queries/buscarNecessidadeCompra: post: description: Retorna as Necessidades de Compras tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro – pagina properties: filtro: type: object allOf: – #/definitions/recFiltroBuscarNecessidadeCompra description: Filtro de pesquisa pagina: type: object allOf: – #/definitions/recPagina description: Paginação orderby: type: string description: Campos para ordenação responses: 200: description: Ok schema: type: object required: – necessidades – totalRegistros properties: necessidades: type: array items: type: object allOf: – #/definitions/recNecessidadeCompraBusca minimum: 1 description: Retorna as necessidades de compra totalRegistros: type: integer format: int64 description: Total de registros default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/queries/buscarTotalNecessidadeCompraPendentes: post: description: Retorna o Total de Necessidades de Compras Pendentes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresaAnalytics description: Empresas responses: 200: description: Ok schema: type: object required: – totalRegistros properties: totalRegistros: type: integer format: int64 description: Total de registros default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/queries/pesquisarEmpresa: post: description: Retorna informações da(s) empresa(s) paginado tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – pagina properties: pesquisa: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base na pesquisa presente texto: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base na pesquisa presente codigo: type: integer format: int64 description: Código da empresa nome: type: string description: Nome da empresa pagina: type: object allOf: – #/definitions/recPagina description: Dados para paginação orderby: type: string description: Campos para ordenação responses: 200: description: Ok schema: type: object required: – empresas – totalRegistros properties: empresas: type: array items: type: object allOf: – #/definitions/empresa minimum: 1 description: Retorna a(s) empresa(s) do(s) filtro(s) informado(s) totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/queries/buscarEmpresa: post: description: Retorna informações da(s) empresa(s) tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: ids: type: array items: type: integer format: int64 description: Identificador único da empresa codigos: type: array items: type: string description: Código da empresa, se ids for informado o código não é usado. responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/empresa minimum: 1 description: Retorna a(s) empresa(s) do(s) id(s) informado(s) default: description: Error response schema: #/definitions/genericError get: description: Retorna informações da(s) empresa(s) tags: – Queries x-senior-visibility: PUBLIC parameters: – name: ids description: Identificador único da empresa in: query type: array items: type: integer format: int64 – name: codigos description: Código da empresa, se ids for informado o código não é usado. in: query type: array items: type: string responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/empresa minimum: 1 description: Retorna a(s) empresa(s) do(s) id(s) informado(s) default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/queries/buscarIdsTodasEmpresas: post: description: Retorna todos os IDs das empresas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das empresas default: description: Error response schema: #/definitions/genericError get: description: Retorna todos os IDs das empresas tags: – Queries x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das empresas default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/queries/buscarFilial: post: description: Retorna informações da(s) filial(s) tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: empresaId: type: integer format: int64 description: Identificador da empresa para o qual a filial pertence ids: type: array items: type: integer format: int64 description: Identificador único da filial codigos: type: array items: type: string description: Código da filial, se ids for informado o empresaId e código não são usados. responses: 200: description: Ok schema: type: object required: – filiais properties: filiais: type: array items: type: object allOf: – #/definitions/filial minimum: 1 description: Retorna filial(s) do(s) filtro(s) informado(s). default: description: Error response schema: #/definitions/genericError get: description: Retorna informações da(s) filial(s) tags: – Queries x-senior-visibility: PUBLIC parameters: – name: empresaId description: Identificador da empresa para o qual a filial pertence in: query type: integer format: int64 – name: ids description: Identificador único da filial in: query type: array items: type: integer format: int64 – name: codigos description: Código da filial, se ids for informado o empresaId e código não são usados. in: query type: array items: type: string responses: 200: description: Ok schema: type: object required: – filiais properties: filiais: type: array items: type: object allOf: – #/definitions/filial minimum: 1 description: Retorna filial(s) do(s) filtro(s) informado(s). default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/queries/buscarIdsFiliaisPorEmpresas: post: description: Buscar IDs das filiais por empresas. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das empresas responses: 200: description: Ok schema: type: object required: – filialIds properties: filialIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das filiais default: description: Error response schema: #/definitions/genericError get: description: Buscar IDs das filiais por empresas. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: empresaIds description: IDs das empresas in: query required: true type: array items: type: integer format: int64 minimum: 1 responses: 200: description: Ok schema: type: object required: – filialIds properties: filialIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das filiais default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/queries/buscarFiliaisMultiplasEmpresas: post: description: Pesquisar filiais de múltiplas empresas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – todas – pagina properties: texto: type: string description: Busca por nome ou código das filiais todas: type: boolean description: Se todas a empresas devem ser buscadas somente: type: array items: type: integer format: int64 description: Somente buscar pelos IDs das empresas exceto: type: array items: type: integer format: int64 description: Todas as empresas, exceto as listadas pagina: type: object allOf: – #/definitions/recPagina description: Paginação responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresaComFiliais minimum: 1 description: Filiais agrupadas por empresa default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/queries/pesquisarFilial: post: description: Retorna filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – pagina properties: codigoEmpresa: type: integer format: int64 description: Empresa para pesquisar empresaId: type: integer format: int64 description: Id da empresa para pesquisar codigo: type: integer format: int64 description: Código da filial nome: type: string description: Nome da filial pesquisa: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base no código e descrição do item presente texto: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base no código e descrição do item presente pagina: type: object allOf: – #/definitions/recPagina description: Dados para paginação orderby: type: string description: Campos para ordenação responses: 200: description: Ok schema: type: object required: – filiais – totalRegistros properties: filiais: type: array items: type: object allOf: – #/definitions/filial minimum: 1 description: Retorna a lista de filial totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/queries/obterUrlUploadAnexo: post: description: Cria o local para armazenamento e busca URL para upload do anexo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeAnexo properties: nomeAnexo: type: string description: nome do arquivo anexo responses: 200: description: Ok schema: type: object required: – url – nome – versao – targetObject properties: url: type: string description: URL para upload do arquivo nome: type: string description: nome do arquivo, informado no input versao: type: string description: versão do arquivo criado targetObject: type: string description: targetObject do arquivo necessario no blobService default: description: Error response schema: #/definitions/genericError get: description: Cria o local para armazenamento e busca URL para upload do anexo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: nomeAnexo description: nome do arquivo anexo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – url – nome – versao – targetObject properties: url: type: string description: URL para upload do arquivo nome: type: string description: nome do arquivo, informado no input versao: type: string description: versão do arquivo criado targetObject: type: string description: targetObject do arquivo necessario no blobService default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/queries/obterUrlDownloadAnexo: post: description: Obtém a URL para download do anexo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeAnexo – versao properties: targetObject: type: string description: targetObject do arquivo necessario no blobService nomeAnexo: type: string description: nome do anexo versao: type: string description: Versão do arquivo responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL para download do recuro default: description: Error response schema: #/definitions/genericError get: description: Obtém a URL para download do anexo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: targetObject description: targetObject do arquivo necessario no blobService in: query type: string – name: nomeAnexo description: nome do anexo in: query required: true type: string – name: versao description: Versão do arquivo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL para download do recuro default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/queries/pesquisarTramites: post: description: Retorna os trâmites da necessidade de compra tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idNecessidadeCompra properties: idNecessidadeCompra: type: string maxLength: 36 description: Identificador único da necessidade compra responses: 200: description: Ok schema: type: object required: – tramites properties: tramites: type: array items: type: object allOf: – #/definitions/recNecessidadeCompraTramite minimum: 1 description: Lista dos trâmites default: description: Error response schema: #/definitions/genericError get: description: Retorna os trâmites da necessidade de compra tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idNecessidadeCompra description: Identificador único da necessidade compra in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – tramites properties: tramites: type: array items: type: object allOf: – #/definitions/recNecessidadeCompraTramite minimum: 1 description: Lista dos trâmites default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/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 description: 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 /nco_necessidadecompra/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 /nco_necessidadecompra/queries/exportFilial: 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 /nco_necessidadecompra/queries/exportFornecedor: 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 /nco_necessidadecompra/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 /nco_necessidadecompra/queries/exportNecessidadeCompra: 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 /nco_necessidadecompra/queries/exportNecessidadeCompraAnexo: 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 /nco_necessidadecompra/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 /nco_necessidadecompra/queries/exportNecessidadeCompraTramite: 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 /nco_necessidadecompra/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 /nco_necessidadecompra/actions/criarNecessidadeCompra: post: description: Cria uma necessidade de compra tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – origem – codigoUnidadeMedida – quantidade properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoSKU: type: string description: Código SKU origem: type: string allOf: – #/definitions/enumOrigemNecessidadeCompra description: Origem codigoUnidadeMedida: type: string description: Código da unidade de medida codigoFilial: type: integer format: int64 description: Código da filial, se o campo origem for do tipo manual o código da filial é obrigatório quantidade: type: number format: double description: Quantidade demandaId: type: integer format: int64 description: Identificador da demanda necessidadeDemandaId: type: integer format: int64 description: Identificador da necessidade de demanda reposicaoItemId: type: string description: Identificador do item da análise de reposição codigoFornecedor: type: integer format: int64 description: Código do fornecedor precoUnitario: type: string description: Preço unitário codigoDeposito: type: string description: Código do depósito complemento: type: string description: Complemento observacao: type: string description: Observação responsavel: type: string description: Responsável rateios: type: array items: type: object allOf: – #/definitions/recNecessidadeCompraRateio description: Rateios enderecoEntregaId: type: integer format: int64 description: Endereço de entrega enderecoFaturamentoId: type: integer format: int64 description: Endereço de faguramento responses: 200: description: Ok schema: type: object required: – id – numero properties: id: type: string maxLength: 36 description: Identificador da necessidade de compra criada numero: type: integer format: int64 description: Número da necessidade de compra criada default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/actions/confirmarNecessidadeCompra: post: description: Realiza a confirmação da necessidade de compra tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametros – selecao properties: parametros: type: object allOf: – #/definitions/recFiltroBuscarNecessidadeCompra description: Parâmetros dos itens ids: type: array items: type: string description: IDs dos itens a serem processados (ou exceto estes itens) selecao: type: string allOf: – #/definitions/enumApenasOuExceto description: Somente os itens responses: 200: description: Ok schema: type: object required: – qtdSucessos – qtdErros properties: qtdSucessos: type: integer format: int64 description: Quantidade total de sucesso qtdErros: type: integer format: int64 description: Quantiadde total de erros default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/actions/cancelarNecessidadeCompra: post: description: Realiza o cancelamento das necessidade de compra tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametros – selecao properties: parametros: type: object allOf: – #/definitions/recFiltroBuscarNecessidadeCompra description: Parâmetros dos itens ids: type: array items: type: string description: IDs dos itens a serem processados (ou exceto estes itens) selecao: type: string allOf: – #/definitions/enumApenasOuExceto description: Somente os itens permanecePendente: type: boolean description: Define se a necessidade volta para pendente ao invés de ser cancelada responses: 200: description: Ok schema: type: object required: – qtdSucessos – qtdErros properties: qtdSucessos: type: integer format: int64 description: Quantidade total de sucesso qtdErros: type: integer format: int64 description: Quantiadde total de erros default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/actions/cancelarNecessidadeCompraCotacao: post: description: Realiza o cancelamento das necessidade de compra que estejam em cotação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ids properties: ids: type: array items: type: string minimum: 1 description: IDs das necessidades responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/actions/atenderNecessidadeCompra: post: description: Realiza o atendimento das necessidade de compra tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametros – selecao properties: parametros: type: object allOf: – #/definitions/recFiltroBuscarNecessidadeCompra description: Parâmetros dos itens ids: type: array items: type: string description: IDs dos itens a serem processados (ou exceto estes itens) selecao: type: string allOf: – #/definitions/enumApenasOuExceto description: Somente os itens responses: 200: description: Ok schema: type: object required: – qtdSucessos – qtdErros properties: qtdSucessos: type: integer format: int64 description: Quantidade total de sucesso qtdErros: type: integer format: int64 description: Quantiadde total de erros default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/actions/cotarNecessidadeCompra: post: description: Manda as necessidade de compra para cotação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametros – selecao properties: parametros: type: object allOf: – #/definitions/recFiltroBuscarNecessidadeCompra description: Parâmetros dos itens ids: type: array items: type: string description: IDs dos itens a serem processados (ou exceto estes itens) selecao: type: string allOf: – #/definitions/enumApenasOuExceto description: Somente os itens responses: 200: description: Ok schema: type: object required: – qtdSucessos – qtdErros properties: qtdSucessos: type: integer format: int64 description: Quantidade total de sucesso qtdErros: type: integer format: int64 description: Quantiadde total de erros default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/actions/assumirNecessidadeCompra: post: description: Atribui um responsável às necessidade de compra tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: ids: type: array items: type: string description: IDs dos itens a serem processados responsavel: type: string description: Responsável que assumirá as necessidades de compra responses: 200: description: Ok schema: type: object required: – qtdSucessos – qtdErros properties: qtdSucessos: type: integer format: int64 description: Quantidade total de sucesso qtdErros: type: integer format: int64 description: Quantiadde total de erros default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/actions/editarNecessidadeCompra: post: description: Editar uma necessidade de compra tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – necessidadeCompraId properties: necessidadeCompraId: type: string maxLength: 36 description: Id da Necessidade Compra a ser editada codigoFornecedor: type: integer format: int64 description: Código do fornecedor codigoDeposito: type: string description: Código do depósito quantidadeCompra: type: number format: double description: Quantidade compra precoUnitario: type: string description: Preço unitário complemento: type: string description: Complemento observacao: type: string description: Observacao responsavel: type: string description: Responsável rateios: type: array items: type: object allOf: – #/definitions/recNecessidadeCompraRateio description: Rateios enderecoEntregaId: type: integer format: int64 description: Endereço de entrega enderecoFaturamentoId: type: integer format: int64 description: Endereço de faguramento responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/actions/salvarAnexo: post: description: Confirma a gravação do arquivo no serviço na versão em que ocorreu o upload tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeAnexo – versao properties: targetObject: type: string description: targetObject do arquivo necessario no blobService nomeAnexo: type: string description: nome do anexo versao: type: string description: versão do anexo (obtida no retorno da primitiva obterUrlUploadAnexo) responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: Resultado da operação (OK) default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/actions/excluirAnexo: post: description: Exclui o anexo do repositório tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeAnexo properties: targetObject: type: string description: targetObject do arquivo necessario no blobService nomeAnexo: type: string description: nome do anexo responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: Resultado da operação (OK) default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/actions/adicionarTramite: post: description: Adiciona um novo trâmite e retorna seu id tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idNecessidadeCompra – observacao properties: idNecessidadeCompra: type: string maxLength: 36 description: Identificador único da necessidade compra idTramite: type: string maxLength: 36 description: Identificador do trâmite de origem quando for uma resposta observacao: type: string maxLength: 250 description: Observação do trâmite responses: 200: description: Ok schema: type: object required: – id properties: id: type: string maxLength: 36 description: Identificador único do trâmite criado default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/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 /nco_necessidadecompra/actions/importFilial: 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 /nco_necessidadecompra/actions/importFornecedor: 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 /nco_necessidadecompra/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 /nco_necessidadecompra/actions/importNecessidadeCompra: 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 /nco_necessidadecompra/actions/importNecessidadeCompraAnexo: 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 /nco_necessidadecompra/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 /nco_necessidadecompra/actions/importNecessidadeCompraTramite: 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 /nco_necessidadecompra/signals/atenderNecessidadeCompraAgendado: post: description: Processo agendado responsável por atender as necessidades de compras tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: codigoEmpresaFilial: type: array items: type: object allOf: – #/definitions/recEmpresaFilial description: Lista de empresa e filial para executar a necessidade de compra responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/signals/atenderNecessidadeCompraManualmente: post: description: Realiza o atendimento das necessidades de compra manualmente, caso ocorra um erro, o usuário será notificado. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – idNecessidades properties: idNecessidades: type: array items: type: string minimum: 1 description: Lista das necessidades que precisam ser atendidas responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/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 /nco_necessidadecompra/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 /nco_necessidadecompra/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 /nco_necessidadecompra/entities/filial: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/filial responses: 200: description: The created resource schema: #/definitions/filial 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/filial responses: 200: description: The created resource schema: #/definitions/filial 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/filial default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/entities/filial/{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/filial responses: 200: description: Ok schema: #/definitions/filial 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/filial responses: 200: description: Ok schema: #/definitions/filial 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/filial 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 /nco_necessidadecompra/entities/filial/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/filial responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/entities/fornecedor: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/fornecedor responses: 200: description: The created resource schema: #/definitions/fornecedor default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/fornecedor responses: 200: description: The created resource schema: #/definitions/fornecedor default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/fornecedor default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/entities/fornecedor/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/fornecedor responses: 200: description: Ok schema: #/definitions/fornecedor default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/fornecedor responses: 200: description: Ok schema: #/definitions/fornecedor default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/fornecedor default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /nco_necessidadecompra/entities/fornecedor/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/fornecedor responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/entities/deposito: post: description: This entity is customizable. 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: description: This entity is customizable. 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: description: This entity is customizable. 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 /nco_necessidadecompra/entities/deposito/{id}: put: description: This entity is customizable. 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: description: This entity is customizable. 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: description: This entity is customizable. 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: description: This entity is customizable. 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 /nco_necessidadecompra/entities/deposito/bulk: post: description: This entity is customizable. 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 /nco_necessidadecompra/entities/necessidadeCompra: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/necessidadeCompra responses: 200: description: The created resource schema: #/definitions/necessidadeCompra default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/necessidadeCompra responses: 200: description: The created resource schema: #/definitions/necessidadeCompra default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/necessidadeCompra default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/entities/necessidadeCompra/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/necessidadeCompra responses: 200: description: Ok schema: #/definitions/necessidadeCompra default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/necessidadeCompra responses: 200: description: Ok schema: #/definitions/necessidadeCompra default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/necessidadeCompra default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /nco_necessidadecompra/entities/necessidadeCompra/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/necessidadeCompra responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/entities/necessidadeCompraAnexo: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/necessidadeCompraAnexo responses: 200: description: The created resource schema: #/definitions/necessidadeCompraAnexo default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/necessidadeCompraAnexo responses: 200: description: The created resource schema: #/definitions/necessidadeCompraAnexo default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/necessidadeCompraAnexo default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/entities/necessidadeCompraAnexo/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/necessidadeCompraAnexo responses: 200: description: Ok schema: #/definitions/necessidadeCompraAnexo default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/necessidadeCompraAnexo responses: 200: description: Ok schema: #/definitions/necessidadeCompraAnexo default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/necessidadeCompraAnexo default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /nco_necessidadecompra/entities/necessidadeCompraAnexo/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/necessidadeCompraAnexo responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/entities/unidadeMedida: post: description: This entity is customizable. 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: description: This entity is customizable. 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: description: This entity is customizable. 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 /nco_necessidadecompra/entities/unidadeMedida/{id}: put: description: This entity is customizable. 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: description: This entity is customizable. 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: description: This entity is customizable. 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: description: This entity is customizable. 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 /nco_necessidadecompra/entities/unidadeMedida/bulk: post: description: This entity is customizable. 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 /nco_necessidadecompra/entities/necessidadeCompraTramite: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/necessidadeCompraTramite responses: 200: description: The created resource schema: #/definitions/necessidadeCompraTramite default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/necessidadeCompraTramite responses: 200: description: The created resource schema: #/definitions/necessidadeCompraTramite default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/necessidadeCompraTramite default: description: Error response schema: #/definitions/genericError /nco_necessidadecompra/entities/necessidadeCompraTramite/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/necessidadeCompraTramite responses: 200: description: Ok schema: #/definitions/necessidadeCompraTramite default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/necessidadeCompraTramite responses: 200: description: Ok schema: #/definitions/necessidadeCompraTramite default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/necessidadeCompraTramite default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /nco_necessidadecompra/entities/necessidadeCompraTramite/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/necessidadeCompraTramite responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: enumCurvaAbc: description: Enumerador de curvas type: string enum: – A – B – C – D enumOrigemNecessidadeCompra: description: Origem da necessidade de compra type: string enum: – Manual – AnaliseReposicao enumOperacao: description: Enumerador de operação de integração type: string enum: – Insercao – Atualizacao – Exclusao enumOrdemCompraTipo: description: Tipo de ordem de compra type: string enum: – ServicoTerceirizacaoIndustrializacao – MaterialUsoConsumo – Servico enumTipoSKU: description: Enumerador de tipo de SKU type: string enum: – NaoClassificado – Mercadoria – MateriaPrima – Intermediario – Embalagem – Manufatura – EmFabricacao – Subproduto – UsoCosumo – AtivoImobilizado – Servico – OutrosInsumos – Outros enumSituacaoNecessidadeCompra: description: Situação da Necessidade de Compra type: string enum: – Pendente – Atendida – Cancelada – Confirmada – AguardandoGeracao – EmCotacao enumSituacaoEndereco: description: Enumerador da situação do endereco de entrega ou faturamento type: string enum: – Ativo – Inativo – Bloqueado enumTipoCompraFornecedor: description: Tipo de Compra do Fornecedor type: string enum: – Compra – Transferencia – CompraCentroDistribuicao enumApenasOuExceto: description: Enumeração para indicar quais necessidades foram fornecidos para confirmação de necessidades type: string enum: – ApenasItens – ExcetoItens enumSituacaoAnexoNecessidadeCompra: description: Enumerador da situação do cadastro de anexos do item da requisição type: string enum: – Ativo – Inativo – Pendente – EmImportacao – Concluido – Erro enumOrigemTramite: description: Origem do trâmite da requisição/necessidade type: string enum: – REQUISICAO – NECESSIDADE upDown: description: Up or down type: string enum: – UP – DOWN 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 recEmpresa: description: Dados da empresa type: object required: – id – codigo – nome – fantasia properties: id: type: integer format: int64 description: Identificador único codigo: type: string description: Código da empresa nome: type: string description: Nome da empresa fantasia: type: string description: Nome fantasia da empresa recFilial: description: Dados da filial type: object required: – id – empresaId – codigo – nome – fantasia properties: id: type: integer format: int64 description: Identificador único empresaId: type: object allOf: – #/definitions/recEmpresa description: Empresa codigo: type: string description: Código da filial nome: type: string description: Nome da filal fantasia: type: string description: Nome fantasia da filial recResponsavel: description: Dados responsável type: object required: – nome – email properties: nome: type: string description: Nome do responsável email: type: string description: E-mail do responsável recEmpresaComFiliais: description: Empresa com suas filiais type: object required: – id – codigo – nome – filiais properties: id: type: integer format: int64 description: Id da empresa codigo: type: string description: Código da empresa nome: type: string description: Nome da empresa filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Filiais recEmpresaFilial: description: Define a combinação de empresa e filial para permitir realizar o filtro type: object required: – codigoEmpresa – codigoFilial properties: codigoEmpresa: type: string description: Código da empresa codigoFilial: type: string description: Código da filial recEmpresaAnalytics: description: Dados da Empresa com suas Filiais do Analytics type: object required: – codigo properties: codigo: type: string maxLength: 4 description: Código codigosFiliais: type: array items: type: string description: Filiais da emrpesa recPagina: description: Dados para paginação de registros type: object required: – offset – limit properties: offset: type: integer format: int64 description: Qual página limit: type: integer format: int64 description: Limite de registros recNecessidadeCompraAlterada: description: Necessidade de compra que foi alterado a situação type: object required: – id properties: id: type: string description: Identificador da necessidade de compra demandaId: type: integer format: int64 description: Identificador da demanda que gerou esta necessidade de compra demandaNecessidadeId: type: integer format: int64 description: Identificador da necessidade de demanda que gerou esta necessidade de compra reposicaoItemId: type: string description: Identificador do item da análise de reposição recNecessidadeCompraBusca: description: Necessidades de Compra type: object required: – origem – empresa – filial – dataSolicitacao – usuarioSolicitacao – situacao – deposito properties: id: type: string description: Identificador origem: type: string allOf: – #/definitions/enumOrigemNecessidadeCompra description: Origem idSKU: type: integer format: int64 description: Id do SKU codigoSKU: type: string description: Código do SKU descricaoSKU: type: string description: Descrição do SKU empresa: type: object allOf: – #/definitions/empresa description: Empresa filial: type: object allOf: – #/definitions/filial description: Filial fornecedor: type: object allOf: – #/definitions/fornecedor description: Fornecedor precoUnitario: type: number format: double description: Preço unitário dataSolicitacao: type: string format: date-time description: Data de solicitação usuarioSolicitacao: type: string description: Usuário de Solicitação dataAtendimento: type: string format: date-time description: Data de atendimento usuarioAtendimento: type: string description: Usuário de Atendimento situacao: type: string allOf: – #/definitions/enumSituacaoNecessidadeCompra description: Situação quantidadeSolicitada: type: number format: double description: Quantidade Solicitada quantidadeCompra: type: number format: double description: Quantidade Compra qtdDisponivelEstoques: type: number format: double description: Saldo total dos estoque do SKU tipoCompra: type: string allOf: – #/definitions/enumTipoCompraFornecedor description: Tipo de compra do SKU erroUltimaAcao: type: string description: Mensagem de erro da ultima ação deposito: type: object allOf: – #/definitions/deposito description: Depósito complemento: type: string description: Complemento observacao: type: string description: Observação responsavel: type: object allOf: – #/definitions/recResponsavel description: Responsável rateios: type: array items: type: object allOf: – #/definitions/recNecessidadeCompraRateioCompleto description: Rateios enderecoEntrega: type: object allOf: – #/definitions/recFilialEndereco description: Endereço de entrega enderecoFaturamento: type: object allOf: – #/definitions/recFilialEndereco description: Endereço de faguramento numero: type: integer format: int64 description: Número Necessidade de Compra numeroSolicitacaoCompra: type: string description: Número Solicitação Compra unidadeMedida: type: object allOf: – #/definitions/recUnidadeMedidaBusca description: Unidade de medida idRequisicaoItem: type: integer format: int64 description: Identificador unico do Item da Requisição recFiltroBuscarNecessidadeCompra: description: Filtro para consulta das necessidades de compra type: object properties: ids: type: array items: type: string description: IDs de necessidades de compra codigosEmpresas: type: array items: type: integer format: int64 description: Códigos de empresas codigosFiliais: type: array items: type: integer format: int64 description: Códigos de filiais skus: type: array items: type: string description: SKUs situacoes: type: array items: type: string allOf: – #/definitions/enumSituacaoNecessidadeCompra description: Situações codigosFamilias: type: array items: type: string description: Códigos das famílias do sku codigosMarcas: type: array items: type: string description: Códigos das marcas do sku codigosFornecedores: type: array items: type: integer format: int64 description: Códigos dos fornecedores codigosDepositos: type: array items: type: string description: Códigos dos depósitos usuariosSolicitacoes: type: array items: type: string description: Usuários das solicitações usuariosAtendimentos: type: array items: type: string description: Usuários das atendimentos dataInicioSolicitacao: type: string format: date description: Data início da solicitação dataFimSolicitacao: type: string format: date description: Data fim da solicitação dataInicioAtendimento: type: string format: date description: Data início do atendimento dataFimAtendimento: type: string format: date description: Data fim do atendimento tiposCompra: type: array items: type: string allOf: – #/definitions/enumTipoCompraFornecedor description: Tipos de compras do SKU numeroReposicao: type: integer format: int64 description: Número da análise de reposição curvaABC: type: array items: type: string allOf: – #/definitions/enumCurvaAbc description: Classe ABC do produto responsavel: type: array items: type: string description: Responsável naoAssumidas: type: boolean description: Não Assumidas numero: type: integer format: int64 description: Número Necessidade de Compra numeroSolicitacaoCompra: type: string description: Número Solicitação Compra recNecessidadeCompraRateio: description: Dados do rateio type: object properties: id: type: string description: Identificador único sequencia: type: integer format: int64 description: Sequência contaFinanceiraId: type: integer format: int64 description: Identificador da conta financeira contaContabilId: type: integer format: int64 description: Identificador da conta contábil centroCustoId: type: integer format: int64 description: Identificador do centro de custo projetoId: type: integer format: int64 description: Identificador do projeto faseId: type: integer format: int64 description: Identificador da fase percentual: type: number format: double description: Percentual valor: type: number format: double description: Valor recNecessidadeCompraRateioCompleto: description: Dados do rateio – com todas as entidades filhas carregadas type: object properties: id: type: string description: Identificador único sequencia: type: integer format: int64 description: Sequência contaFinanceira: type: object allOf: – #/definitions/recContaFinanceira description: Financeira contaContabil: type: object allOf: – #/definitions/recContaContabil description: Contábil centroCusto: type: object allOf: – #/definitions/recCentroCusto description: Centro de custo projeto: type: object allOf: – #/definitions/recProjeto description: Projeto fase: type: object allOf: – #/definitions/recFase description: Fase percentual: type: number format: double description: Percentual valor: type: number format: double description: Valor recFilialEndereco: description: Dados do endereço de entrega e de faturamento da necessidade type: object required: – id – codigoEmpresa – empresa – codigoFilial – filial – endereco – cep – cidade properties: id: type: integer format: int64 description: Identificador do endereço codigoEmpresa: type: string description: Código da empresa empresa: type: string description: Código – Descrição da empresa codigoFilial: type: string description: Código da filial filial: type: string description: Código – Descrição da filial endereco: type: string description: Endereço cep: type: string description: CEP cidade: type: string description: Cidade recContaFinanceira: description: Dados da conta financeira type: object required: – id properties: id: type: integer format: int64 description: Identificador único codigo: type: string description: Código mascarado da conta financeira descricao: type: string description: Descrição da conta financeira recContaContabil: description: Dados da conta contábil type: object properties: id: type: integer format: int64 description: Identificador único codigo: type: string description: Código mascarado da conta contábil descricao: type: string description: Descrição da conta contábil recCentroCusto: description: Dados do centro de custo type: object required: – id properties: id: type: integer format: int64 description: Identificador único codigo: type: string description: Código do centro de custo descricao: type: string description: Descrição do centro de custo recProjeto: description: Dados do projeto type: object required: – id – numero – nome properties: id: type: integer format: int64 description: Identificador do projeto numero: type: integer format: int64 description: Número do projeto nome: type: string maxLength: 150 description: Nome recFase: description: Dados do fase type: object required: – id – codigo – descricao properties: id: type: integer format: int64 description: Identificador do projeto codigo: type: integer format: int64 description: Código da fase descricao: type: string maxLength: 100 description: Descrição da fase recUnidadeMedidaBusca: description: Dados da unidade de medida type: object required: – id – codigo – descricao – quantidadeDecimais properties: id: type: integer format: int64 description: Identificador único codigo: type: string description: Código da unidade de medida descricao: type: string description: Descrição da unidade de medida quantidadeDecimais: type: integer format: int64 description: Quantidade de decimais da unidade de medida recNecessidadeCompraTramite: description: Trâmites da Necessidade Compra type: object required: – usuarioOrigem – usuarioDestino – origem properties: id: type: string maxLength: 36 description: Identificador único idRequisicaoItem: type: integer format: int64 description: Identificador do item da requisição idNecessidadeCompra: type: string maxLength: 36 description: Identificador da necessidade de compra idTramite: type: string maxLength: 36 description: Identificador do trâmite de origem quando for uma resposta usuarioOrigem: type: string maxLength: 50 description: Usuário que enviou o trâmite usuarioDestino: type: string maxLength: 50 description: Usuário para quem será enviado o trâmite origem: type: string allOf: – #/definitions/enumOrigemTramite description: Origem do trâmite observacao: type: string maxLength: 250 description: Observação do trâmite dataEnvio: type: string format: date-time description: Data de envio checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck empresa: description: Empresa type: object required: – codigo – nome – fantasia properties: id: type: integer format: int64 description: Identificador único, deve ser informado nas operações de atualização e exclusão codigo: type: string maxLength: 4 description: Código nome: type: string maxLength: 100 description: Nome fantasia: type: string maxLength: 10 description: Nome fantasia filiais: type: array items: type: object allOf: – #/definitions/filial description: Filiais da emrpesa usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: filial: description: Filial type: object required: – empresa – codigo – nome – fantasia properties: id: type: integer format: int64 description: Identificador único, deve ser informado nas operações de atualização e exclusão empresa: type: object allOf: – #/definitions/empresa description: Identificador único da empresa codigo: type: string maxLength: 4 description: Código nome: type: string maxLength: 100 description: Nome fantasia: type: string maxLength: 30 description: Fantasia usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: fornecedor: description: Fornecedor type: object required: – cnpjcpf – codigo – nome properties: id: type: integer format: int64 description: Identificador único cnpjcpf: type: string description: CNPJ/CPF codigo: type: string description: Código do fornecedor nome: type: string description: Nome nomeFantasia: type: string description: Nome fantasia 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 – filial_id – empresa_id – descricao properties: id: type: integer format: int64 description: Identificador único codigo: type: string description: Código do depósito filial_id: type: object allOf: – #/definitions/filial description: Identificador único da filial empresa_id: type: integer format: int64 description: Identificador único da empresa descricao: type: string description: Descriçã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: necessidadeCompra: description: Necessidade de compra type: object properties: id: type: string format: uuid 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: necessidadeCompraAnexo: description: Anexo da necessidade de compra type: object required: – necessidadeCompra – nomeArquivo – versaoArquivo – situacao properties: id: type: string format: uuid description: Identificador único necessidadeCompra: type: object allOf: – #/definitions/necessidadeCompra description: Identificador único da necessidade de compra nomeArquivo: type: string maxLength: 100 description: Nome do arquivo versaoArquivo: type: string maxLength: 50 description: Versão do arquivo targetObject: type: string format: uuid description: TargetObject do arquivo necessario para o blobservice situacao: type: string allOf: – #/definitions/enumSituacaoAnexoNecessidadeCompra description: Situação logImportacao: type: string description: Log da importação do arquivo permiteAlteracao: type: boolean description: Indicadivo se permite alterar/remover o anexo default: true tramiteId: type: string format: uuid description: Identificador único do trâmite da necessidade de compra usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: unidadeMedida: description: 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 maxLength: 3 description: Código descricao: type: string maxLength: 100 description: Descrição 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: necessidadeCompraTramite: description: Trâmites da requisição de compra type: object required: – idNecessidadeCompra – usuarioOrigem – usuarioDestino – origem properties: id: type: string format: uuid description: Identificador único idRequisicaoItem: type: integer format: int64 description: Identificador do item da requisição idNecessidadeCompra: type: string format: uuid description: Identificador da necessidade de compra idTramite: type: string format: uuid description: Identificador do trâmite de origem quando for uma resposta usuarioOrigem: type: string maxLength: 50 description: Usuário que enviou o trâmite usuarioDestino: type: string maxLength: 50 description: Usuário para quem será enviado o trâmite origem: type: string allOf: – #/definitions/enumOrigemTramite description: Origem do trâmite observacao: type: string maxLength: 250 description: Observação do trâmite 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: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string 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