erp_sup

com_comum

20 views 04/08/2020 01/04/2021 integrador 0

2.0info: 3.0.1 com_comum description: Serviços comuns entre os serviços do comercial Senior X x-senior-domain: erp_sup x-senior-domain-path: erp_sup x-senior-service-path: com_comum contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erp_supsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /com_comum/queries/buscarSkuSubstituido: post: description: Pesquisa sku substituido tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: skuIds: type: array items: type: integer format: int64 description: Lista de IDs de sku skus: type: array items: type: object allOf: – #/definitions/recSkuPorCodigo description: Lista de Skus (skuIds será ignorado caso passe esses dados) pagina: type: object allOf: – #/definitions/recPagina description: Pagina responses: 200: description: Ok schema: type: object required: – skusSubstituidos properties: skusSubstituidos: type: array items: type: object allOf: – #/definitions/recSkuSubstituto minimum: 1 description: Lista de recSkuSubstituto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarDeposito: post: description: Retorna depósitos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: codigosEmpresas: type: array items: type: integer format: int64 description: Código das empresas codigoEmpresa: type: integer format: int64 description: Código da empresa filial: type: string description: Código ou nome da filial pesquisa: type: string description: Texto para pesquisar por código ou descrição codigo: type: string description: Codigo para pesquisa descricao: type: string description: Descricao para pesquisa 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: – depositos – totalRegistros properties: depositos: type: array items: type: object allOf: – #/definitions/recDeposito minimum: 1 description: Retorna lista de contas financeiras totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarDepositoSaldoEstoque: post: description: Retorna depósitos com saldo em estoque do SKU pesquisado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – idSku – pagina properties: codigoEmpresa: type: integer format: int64 description: Código da empresa filial: type: string description: Código ou nome da filial pesquisa: type: string description: Texto para pesquisar por código ou descrição codigo: type: string description: Codigo para pesquisa descricao: type: string description: Descricao para pesquisa idSku: type: integer format: int64 description: SKU para pesquisar saldo estoque 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: – depositos – totalRegistros properties: depositos: type: array items: type: object allOf: – #/definitions/recDepositoSaldoEstoque minimum: 1 description: Retorna lista de contas financeiras totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarEmpresa: post: description: Retorna empresa tags: – Queries x-senior-visibility: PRIVATE 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/recEmpresa minimum: 1 description: Retorna a lista de empresas totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/buscarIdsTodasEmpresas: post: description: Retorna todos os IDs das empresas tags: – Queries x-senior-visibility: PRIVATE 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna todos os IDs das empresas tags: – Queries x-senior-visibility: PRIVATE 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/buscarIdsFiliaisPorEmpresas: post: description: Buscar IDs das filiais por empresas. tags: – Queries x-senior-visibility: PRIVATE 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Buscar IDs das filiais por empresas. tags: – Queries x-senior-visibility: PRIVATE 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/buscarFiliaisMultiplasEmpresas: post: description: Pesquisar filiais de múltiplas empresas tags: – Queries x-senior-visibility: PRIVATE 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/buscarEmpresa: post: description: Retorna informações da empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: id: type: integer format: int64 description: Identificador único da empresa codigo: type: string description: Código da empresa, se o id for informado o código não é usado. responses: 200: description: Ok schema: type: object required: – empresa properties: empresa: type: object allOf: – #/definitions/recEmpresa description: Retorna a empresa do id informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna informações da empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador único da empresa in: query type: integer format: int64 – name: codigo description: Código da empresa, se o id for informado o código não é usado. in: query type: string responses: 200: description: Ok schema: type: object required: – empresa properties: empresa: type: object allOf: – #/definitions/recEmpresa description: Retorna a empresa do id informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/buscarEmpresas: post: description: Retorna informações das empresas tags: – Queries 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: Identificador único das empresas responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Retorna as empresas dos ids informados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna informações das empresas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ids description: Identificador único das empresas in: query required: true type: array items: type: integer format: int64 minimum: 1 responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Retorna as empresas dos ids informados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/buscarFiliais: post: description: Retorna informações das filiais tags: – Queries 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: Identificador único das filiais responses: 200: description: Ok schema: type: object required: – filiais properties: filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Retorna as filiais dos ids informados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna informações das filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ids description: Identificador único das filiais in: query required: true type: array items: type: integer format: int64 minimum: 1 responses: 200: description: Ok schema: type: object required: – filiais properties: filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Retorna as filiais dos ids informados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarFornecedor: post: description: Retorna dados gerais da Fornecedor tags: – Queries x-senior-visibility: PRIVATE 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 no CNPJ, Nome, Nome fantasia do item presente codigo: type: integer format: int64 description: Código do fornecedor nome: type: string description: Nome fantasia fornecedor cnpj: type: string description: CNPJ fornecedor filialFornecedor: type: integer format: int64 description: Indicativo se fornecedores pode ser filiais, 1 -Somente filiais, 2 – Somente não filiais, se não informado ambos somenteRequisitados: type: string allOf: – #/definitions/enumSimNao description: Somente fornecedores ativos pagina: type: object allOf: – #/definitions/recPagina description: Dados para paginação orderby: type: string description: Campos para ordenação. Quando não informado, ordena por código de fornecedor responses: 200: description: Ok schema: type: object required: – fornecedores – totalRegistros properties: fornecedores: type: array items: type: object allOf: – #/definitions/recFornecedor minimum: 1 description: Retorna lista de fornecedores totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarTodasFiliais: post: description: Retorna todas as filial. Não é utilizado pelo componente de empresa/filial tags: – Queries x-senior-visibility: PRIVATE 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 no código e nome da filial 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/recFilial minimum: 1 description: Retorna a lista de filial totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarFilial: post: description: Retorna filial tags: – Queries x-senior-visibility: PRIVATE 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/recFilial minimum: 1 description: Retorna a lista de filial totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/buscarFilial: post: description: Retorna informações da filial tags: – Queries x-senior-visibility: PRIVATE 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 id: type: integer format: int64 description: Identificador único da filial codigo: type: string description: Código da filial responses: 200: description: Ok schema: type: object required: – filial properties: filial: type: object allOf: – #/definitions/recFilial description: Retorna a filial do id informado. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna informações da filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: Identificador da empresa para o qual a filial pertence in: query type: integer format: int64 – name: id description: Identificador único da filial in: query type: integer format: int64 – name: codigo description: Código da filial in: query type: string responses: 200: description: Ok schema: type: object required: – filial properties: filial: type: object allOf: – #/definitions/recFilial description: Retorna a filial do id informado. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarSku: post: description: Retorna dados gerais do SKU tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: codigosEmpresas: type: array items: type: integer format: int64 description: Empresas para pesquisar codigoEmpresa: type: integer format: int64 description: Empresa para pesquisar 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 codigo: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base no código descricao: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base na descrição familia: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base no código e descrição da familia categoria: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base no código e descrição da categoria marca: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base no código e descrição da marca skuId: type: array items: type: integer format: int64 description: Lista de Id de Sku (caso seja informado será desconsiderado os outros parâmetros) skuIdOrigem: type: integer format: int64 description: Sku origem utilizado para consulta (não será apresentado nos resultados) tipoQualidade: type: string allOf: – #/definitions/enumTipoQualidadeSKU description: Tipo de qualidade somenteRequisitados: type: string allOf: – #/definitions/enumSimNao description: Somente produtos que podem ser requisitados somenteComprados: type: string allOf: – #/definitions/enumSimNao description: Somente produtos que podem ser comprados orderby: type: string description: Ordenação pagina: type: object allOf: – #/definitions/recPagina description: Dados para paginação responses: 200: description: Ok schema: type: object required: – skus – totalRegistros properties: skus: type: array items: type: object allOf: – #/definitions/recSku minimum: 1 description: Retorna lista de itens (produtos/serviços) da empresa informada totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/buscarSku: post: description: Retorna o cadastro completo do SKU tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idSku properties: idSku: type: integer format: int64 description: Identificador único do SKU responses: 200: description: Ok schema: type: object required: – sku – skuComplemento properties: sku: type: object allOf: – #/definitions/recSkuEntidade description: Retorna os dados gerais do SKU skuComplemento: type: object allOf: – #/definitions/recSkuComplementoEntidade description: Retorna o complemento do SKU produtoSubstituto: type: object allOf: – #/definitions/recSkuEntidade description: Produto Substituto skuSubstituidos: type: array items: type: object allOf: – #/definitions/skuSubstituidoEntidade description: Lista de Sku Substituido 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o cadastro completo do SKU tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idSku description: Identificador único do SKU in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – sku – skuComplemento properties: sku: type: object allOf: – #/definitions/recSkuEntidade description: Retorna os dados gerais do SKU skuComplemento: type: object allOf: – #/definitions/recSkuComplementoEntidade description: Retorna o complemento do SKU produtoSubstituto: type: object allOf: – #/definitions/recSkuEntidade description: Produto Substituto skuSubstituidos: type: array items: type: object allOf: – #/definitions/skuSubstituidoEntidade description: Lista de Sku Substituido 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarSkuCriterios: post: description: Retorna códigos de SKU que atendem determinados critérios tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: codigoEmpresa: type: array items: type: integer format: int64 description: Empresas para pesquisar os SKUs codigoFamilia: type: array items: type: string description: Famílias para pesquisar SKUs codigoSKU: type: array items: type: string description: SKUs a serem pesquisados codigoFornecedor: type: array items: type: integer format: int64 description: Fornecedores a serem pesquisados codigoCategoriaSku: type: array items: type: string description: Categorias de SKUs a serem pesquisados pagina: type: object allOf: – #/definitions/recPagina description: Dados para paginação responses: 200: description: Ok schema: type: object required: – itens properties: itens: type: array items: type: object allOf: – #/definitions/recSkuCriterios minimum: 1 description: Itens localizados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/buscarLigacaoSkuFornecedor: post: description: Busca as ligações que um SKU possui tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametros properties: parametros: type: array items: type: object allOf: – #/definitions/recParametrosBuscaLigacaoSkuFornecedor minimum: 1 description: Parâmetros para busca da ligação do Sku com fornecedor codigoFornecedor: type: array items: type: integer format: int64 description: Código do fornecedor para realizar a busca responses: 200: description: Ok schema: type: object required: – ligacoes properties: ligacoes: type: array items: type: object allOf: – #/definitions/recLigacaoSkuFornecedor minimum: 1 description: Ligações encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/calcularComprasEmAndamento: post: description: Busca o total de compras que estão em andamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametros properties: parametros: type: array items: type: object allOf: – #/definitions/recParametrosComprasEmAndamento minimum: 1 description: Parâmetros para buscar as compras em andamento tipoDocumentoCompra: type: integer format: int64 description: Tipo de documento de compra a considerar responses: 200: description: Ok schema: type: object required: – itens properties: itens: type: array items: type: object allOf: – #/definitions/recComprasEmAndamento minimum: 1 description: Quantidade em compras 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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: – targetObject – url – nome – versao properties: targetObject: type: string description: targetObject do arquivo necessário no blobService 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 401: description: Invalid Credentials 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: – targetObject – url – nome – versao properties: targetObject: type: string description: targetObject do arquivo necessário no blobService 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/buscarCategoria: post: description: Retorna o cadastro da categoria tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – categoriaId properties: categoriaId: type: string maxLength: 36 description: ID da categoria responses: 200: description: Ok schema: type: object required: – categoria properties: categoria: type: object allOf: – #/definitions/categoria description: Retorna os dados da categoria 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o cadastro da categoria tags: – Queries x-senior-visibility: PRIVATE parameters: – name: categoriaId description: ID da categoria in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – categoria properties: categoria: type: object allOf: – #/definitions/categoria description: Retorna os dados da categoria 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarCategoria: post: description: Retorna dados da categoria tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: codigosEmpresas: type: array items: type: integer format: int64 description: Empresa para pesquisar codigoEmpresa: type: array items: type: integer format: int64 description: Empresa para pesquisar 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 codigo: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base no código descricao: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base na descrição categoriaPai: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base na categoria pai pagina: type: object allOf: – #/definitions/recPagina description: Dados para paginação orderby: type: string description: Define ordenação dos dados responses: 200: description: Ok schema: type: object required: – categorias properties: categorias: type: array items: type: object allOf: – #/definitions/recCategoria minimum: 1 description: Retorna lista de categorias da empresa informada totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarHierarquiaCategoria: post: description: Retorna dados da categoria tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – categoriaPai properties: codigoEmpresa: type: integer format: int64 description: Empresa para pesquisar categoriaPai: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base na categoria pai responses: 200: description: Ok schema: type: object required: – categorias properties: categorias: type: array items: type: object allOf: – #/definitions/categoria minimum: 1 description: Retorna lista de categorias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna dados da categoria tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa description: Empresa para pesquisar in: query required: true type: integer format: int64 – name: categoriaPai description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base na categoria pai in: query required: true type: string responses: 200: description: Ok schema: type: object required: – categorias properties: categorias: type: array items: type: object allOf: – #/definitions/categoria minimum: 1 description: Retorna lista de categorias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/obterArvoreCategorias: post: description: Obtém a árvore de categorias cadastradas para um empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId properties: empresaId: type: integer format: int64 description: Id da empresa responses: 200: description: Ok schema: type: object required: – categorias properties: categorias: type: array items: type: object allOf: – #/definitions/recNoCategoria minimum: 1 description: Árvore de categorias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a árvore de categorias cadastradas para um empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: Id da empresa in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – categorias properties: categorias: type: array items: type: object allOf: – #/definitions/recNoCategoria minimum: 1 description: Árvore de categorias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarUnidadeMedida: post: description: Retorna dados gerais da Unidade Medida tags: – Queries x-senior-visibility: PRIVATE 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 no código e descrição do item presente codigo: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base no código descricao: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base na descrição 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: – unidadesMedida – totalRegistros properties: unidadesMedida: type: array items: type: object allOf: – #/definitions/recUnidadeMedida minimum: 1 description: Retorna lista de itens (unidades de medida) totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarEnderecoFilial: post: description: Retorna dados gerais do endereço de entrega/faturamento. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – tipoEndereco – pagina properties: codigoEmpresa: type: string description: Empresa tipoEndereco: type: string allOf: – #/definitions/enumTipoEndereco description: Tipo do endereço pesquisa: type: string description: Pesquisa na base o endereço ou o CEP filial: type: string description: Filial endereco: type: string description: Endereço de entrega ou faturamento cep: type: string description: CEP cidade: type: string description: Cidade 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: – endereco – totalRegistros properties: endereco: type: array items: type: object allOf: – #/definitions/recFilialEndereco minimum: 1 description: Retorna lista de endereços de entrega totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/buscarUnidadeMedida: post: description: Retorna o cadastro completo da unidade de medida tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – unidadeMedidaId properties: unidadeMedidaId: type: integer format: int64 description: Identificador único da unidade de medida responses: 200: description: Ok schema: type: object required: – unidadeMedida properties: unidadeMedida: type: object allOf: – #/definitions/unidadeMedida description: Retorna os dados gerais da unidade de medida 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o cadastro completo da unidade de medida tags: – Queries x-senior-visibility: PRIVATE parameters: – name: unidadeMedidaId description: Identificador único da unidade de medida in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – unidadeMedida properties: unidadeMedida: type: object allOf: – #/definitions/unidadeMedida description: Retorna os dados gerais da unidade de medida 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarFamilia: post: description: Retorna dados gerais da Familia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: codigosEmpresas: type: array items: type: integer format: int64 description: Empresa para pesquisar codigoEmpresa: type: integer format: int64 description: Empresa para pesquisar 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 codigo: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base no código descricao: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base na descrição somenteComprado: type: boolean description: Este campo determina que a pesquisa da família ira trazer apenas famílias do tipo de produto comprado 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: – familias – totalRegistros properties: familias: type: array items: type: object allOf: – #/definitions/recFamilia minimum: 1 description: Retorna lista de itens (familia) totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/buscarFamilia: post: description: Retorna o cadastro completo da familia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – familiaId properties: familiaId: type: integer format: int64 description: Identificador único da familia responses: 200: description: Ok schema: type: object required: – familia properties: familia: type: object allOf: – #/definitions/familia description: Retorna os dados gerais da familia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o cadastro completo da familia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: familiaId description: Identificador único da familia in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – familia properties: familia: type: object allOf: – #/definitions/familia description: Retorna os dados gerais da familia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarLigacaoSkuFilial: post: description: Retorna dados das ligações pesquisadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – pagina properties: codigoEmpresa: type: integer format: int64 description: Empresa para pesquisar codigoSKU: type: string description: Código do SKU skuId: type: integer format: int64 description: SKU codigoFilial: type: integer format: int64 description: Código da Filial filialId: type: integer format: int64 description: Filial pagina: type: object allOf: – #/definitions/recPagina description: Dados para paginação responses: 200: description: Ok schema: type: object required: – ligacaoSkuFilial – totalRegistros properties: ligacaoSkuFilial: type: array items: type: object allOf: – #/definitions/recLigacaoSkuFilial minimum: 1 description: Retorna lista das ligações totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarLigacaoSkuFilialFornecedor: post: description: Retorna dados da categoria tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – pagina properties: codigoEmpresa: type: integer format: int64 description: Empresa para pesquisar skuId: type: integer format: int64 description: SKU filialId: type: integer format: int64 description: Filial fornecedorId: type: integer format: int64 description: Fornecedor skuFilialId: type: string description: Ligação Sku/Filial pagina: type: object allOf: – #/definitions/recPagina description: Dados para paginação responses: 200: description: Ok schema: type: object required: – ligacaoSkuFilialFornecedor – totalRegistros properties: ligacaoSkuFilialFornecedor: type: array items: type: object allOf: – #/definitions/recLigacaoSkuFilialFornecedor minimum: 1 description: Retorna lista das ligações totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarMarca: post: description: Retorna os dados da Marca tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: codigosEmpresas: type: array items: type: integer format: int64 description: Empresas para pesquisar codigoEmpresa: type: integer format: int64 description: Empresa para pesquisar 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 codigo: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base no código nome: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base na descrição pagina: type: object allOf: – #/definitions/recPagina description: Dados para paginação orderby: type: string description: Define a ordenação dos dados responses: 200: description: Ok schema: type: object required: – marcas – totalRegistros properties: marcas: type: array items: type: object allOf: – #/definitions/recMarca minimum: 1 description: Retorna lista de marcas totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarContaFinanceira: post: description: Retorna contas financeiras tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – pagina properties: codigoEmpresa: type: integer format: int64 description: Recebe empresa como parâmetro pesquisa: type: string description: Texto para pesquisar por código ou descrição codigo: type: integer format: int64 description: Código da conta descricao: type: string description: Descrição da conta projetoId: type: integer format: int64 description: Identificador do projeto selecionado, utilizado para filtrar os relacionamento do registro com o projeto 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: – contasFinanceiras – totalRegistros properties: contasFinanceiras: type: array items: type: object allOf: – #/definitions/recContaFinanceira minimum: 1 description: Retorna lista de contas financeiras totalRegistros: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarHierarquiaContaFinanceira: post: description: Retorna contas financeiras em formato hierárquico tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa properties: codigoEmpresa: type: integer format: int64 description: Recebe empresa como parâmetro idContaFinanceira: type: integer format: int64 description: Conta Financeira responses: 200: description: Ok schema: type: object required: – contasFinanceiras properties: contasFinanceiras: type: array items: type: object allOf: – #/definitions/recContaFinanceira minimum: 1 description: Retorna lista de contas financeiras 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna contas financeiras em formato hierárquico tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa description: Recebe empresa como parâmetro in: query required: true type: integer format: int64 – name: idContaFinanceira description: Conta Financeira in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – contasFinanceiras properties: contasFinanceiras: type: array items: type: object allOf: – #/definitions/recContaFinanceira minimum: 1 description: Retorna lista de contas financeiras 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarContaContabil: post: description: Retorna contas contábeis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – pagina properties: codigoEmpresa: type: integer format: int64 description: Recebe empresa como parâmetro pesquisa: type: string description: Texto para pesquisar por código ou descrição pagina: type: object allOf: – #/definitions/recPagina description: Dados para paginação responses: 200: description: Ok schema: type: object required: – contasContabeis – totalRegistros properties: contasContabeis: type: array items: type: object allOf: – #/definitions/recContaContabil minimum: 1 description: Retorna lista de contas contábeis totalRegistros: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarHierarquiaContaContabil: post: description: Retorna contas contábeis em formato hierárquico tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa properties: codigoEmpresa: type: integer format: int64 description: Recebe empresa como parâmetro idContaContabil: type: integer format: int64 description: Conta Contabil responses: 200: description: Ok schema: type: object required: – contasContabeis properties: contasContabeis: type: array items: type: object allOf: – #/definitions/recContaContabil minimum: 1 description: Retorna lista de contas contábeis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna contas contábeis em formato hierárquico tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa description: Recebe empresa como parâmetro in: query required: true type: integer format: int64 – name: idContaContabil description: Conta Contabil in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – contasContabeis properties: contasContabeis: type: array items: type: object allOf: – #/definitions/recContaContabil minimum: 1 description: Retorna lista de contas contábeis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarCentroCusto: post: description: Retorna centros de custos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – pagina properties: codigoEmpresa: type: integer format: int64 description: Recebe empresa como parâmetro codigo: type: string description: Código para pesquisa descricao: type: string description: Descrição para pesquisa pesquisa: type: string description: Texto para pesquisar por código ou descrição projetoId: type: integer format: int64 description: Identificador do projeto selecionado, utilizado para filtrar os relacionamento do registro com o projeto 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: – centrosCustos – totalRegistros properties: centrosCustos: type: array items: type: object allOf: – #/definitions/recCentroCusto minimum: 1 description: Retorna lista de centros de custos totalRegistros: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarHierarquiaCentroCusto: post: description: Retorna centros de custo em formato hierárquico tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa properties: codigoEmpresa: type: integer format: int64 description: Recebe empresa como parâmetro idCentroCusto: type: integer format: int64 description: Centro de Custo responses: 200: description: Ok schema: type: object required: – centrosCustos properties: centrosCustos: type: array items: type: object allOf: – #/definitions/recCentroCusto minimum: 1 description: Retorna lista de centros de custo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna centros de custo em formato hierárquico tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa description: Recebe empresa como parâmetro in: query required: true type: integer format: int64 – name: idCentroCusto description: Centro de Custo in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – centrosCustos properties: centrosCustos: type: array items: type: object allOf: – #/definitions/recCentroCusto minimum: 1 description: Retorna lista de centros de custo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarHierarquiaFase: post: description: Retorna fases em formato hierárquico tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – projetoId properties: codigoEmpresa: type: integer format: int64 description: Recebe empresa como parâmetro projetoId: type: integer format: int64 description: Projeto em que a fase pertence codigoFase: type: integer format: int64 description: Codigo da Fase responses: 200: description: Ok schema: type: object required: – fases properties: fases: type: array items: type: object allOf: – #/definitions/recFase minimum: 1 description: Retorna lista de fases 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna fases em formato hierárquico tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa description: Recebe empresa como parâmetro in: query required: true type: integer format: int64 – name: projetoId description: Projeto em que a fase pertence in: query required: true type: integer format: int64 – name: codigoFase description: Codigo da Fase in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – fases properties: fases: type: array items: type: object allOf: – #/definitions/recFase minimum: 1 description: Retorna lista de fases 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarProjeto: post: description: Retorna projeto para cadastro de requisição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – pagina properties: codigoEmpresa: type: integer format: int64 description: Empresa para pesquisar pesquisa: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base no número e nome do projeto presente numero: type: integer format: int64 description: Número do projeto nome: type: string description: Nome do projeto 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: – projetos – totalRegistros properties: projetos: type: array items: type: object allOf: – #/definitions/recProjeto minimum: 1 description: Retorna lista de projetos da empresa informada totalRegistros: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/pesquisarFase: post: description: Retorna fases de um projeto para cadastro de requisição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – projetoId – pagina properties: projetoId: type: integer format: int64 description: Projeto em que a fase pertence pesquisa: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base no código e descrição da fase presente codigo: type: integer format: int64 description: Código da fase descricao: type: string description: Descrição da fase 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: – fases – totalRegistros properties: fases: type: array items: type: object allOf: – #/definitions/recFase minimum: 1 description: Retorna lista de fases do projeto informado totalRegistros: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/buscarParametrizacaoFilial: post: description: Retorna a parametrização da filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa properties: codigoEmpresa: type: integer format: int64 description: Recebe empresa como parâmetro codigoFilial: type: integer format: int64 description: Recebe filial como parâmetro responses: 200: description: Ok schema: type: object required: – parametros properties: parametros: type: object allOf: – #/definitions/recParametrizacaoFilialBusca description: Retornas os parâmetros da filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a parametrização da filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa description: Recebe empresa como parâmetro in: query required: true type: integer format: int64 – name: codigoFilial description: Recebe filial como parâmetro in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – parametros properties: parametros: type: object allOf: – #/definitions/recParametrizacaoFilialBusca description: Retornas os parâmetros da filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/buscarUsuariosEmpresa: post: description: Retorna todos os usuários do domínio Suprimentos da Empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: codigoEmpresa: type: integer format: int64 description: Código da empresa pesquisa: type: string description: Texto para pesquisar por login 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: – usuarios – totalRegistros properties: usuarios: type: array items: type: object allOf: – #/definitions/recParametrosUsuario minimum: 1 description: Retorna os usuários da empresa totalRegistros: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/obterProximoNumeroRequisicao: post: description: Retorna o próximo número de requisição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId properties: empresaId: type: integer format: int64 description: ID da empresa responses: 200: description: Ok schema: type: object required: – empresaId – proximoNumeroRequisicao properties: empresaId: type: integer format: int64 description: ID da empresa proximoNumeroRequisicao: type: integer format: int64 description: Próxima numeração de requisição exigeSkuEnvioRequisicao: type: boolean description: Indicativo se permitirá o envio de requisições sem um SKU informado, ou seja, só descrição do complemento informada. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o próximo número de requisição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: ID da empresa in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – empresaId – proximoNumeroRequisicao properties: empresaId: type: integer format: int64 description: ID da empresa proximoNumeroRequisicao: type: integer format: int64 description: Próxima numeração de requisição exigeSkuEnvioRequisicao: type: boolean description: Indicativo se permitirá o envio de requisições sem um SKU informado, ou seja, só descrição do complemento informada. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/buscarTipoNotificacaoTramite: post: description: Retorna o tipo de notificação para receber os trâmites de requisição e necessidade de compra tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – empresaId – usuario properties: empresaId: type: integer format: int64 description: ID da empresa usuario: type: string description: Usuário responses: 200: description: Ok schema: type: object required: – tipoNotificacaoTramite properties: tipoNotificacaoTramite: type: string allOf: – #/definitions/enumTipoNotificacaoTramite description: Tipo de notificação dos trãmites 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o tipo de notificação para receber os trâmites de requisição e necessidade de compra tags: – Queries x-senior-visibility: PUBLIC parameters: – name: empresaId description: ID da empresa in: query required: true type: integer format: int64 – name: usuario description: Usuário in: query required: true type: string responses: 200: description: Ok schema: type: object required: – tipoNotificacaoTramite properties: tipoNotificacaoTramite: type: string allOf: – #/definitions/enumTipoNotificacaoTramite description: Tipo de notificação dos trãmites 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportEstado: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportCidade: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportMarca: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportCategoria: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportSkuImagem: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportContaContabil: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportContaFinanceira: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportCentroCusto: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportProjeto: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportFase: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportSkuSubstituido: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportNumeracaoRequisicao: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportRelacionamentoContaFinanc: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportRelacionamentoContaContabil: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportRelacionamentoCentroCusto: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportRelacionamentoProjeto: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportRelaciProjetoContafinanceira: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportRelacionamProjetoCentrocusto: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportParametrosUsuario: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportFilialEndereco: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportParametrizacao: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportSkuFilial: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/queries/exportSkuFilialFornecedor: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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 necessário 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) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/gravarSku: post: description: Grava os dados do SKU tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – sku – skuComplemento properties: sku: type: object allOf: – #/definitions/sku description: Dados gerais do SKU skuComplemento: type: object allOf: – #/definitions/recSkuComplemento description: Complemento do SKU skusSubstituidos: type: array items: type: object allOf: – #/definitions/skuSubstituido description: Skus substituídos skuFilial: type: array items: type: object allOf: – #/definitions/recLigacaoSkuFilial description: Ligações SKU/Filial skuFilialFornecedor: type: array items: type: object allOf: – #/definitions/recLigacaoSkuFilialFornecedor description: Ligações skuFilial/Fornecedor responses: 200: description: Ok schema: type: object required: – sku – skuComplemento properties: sku: type: object allOf: – #/definitions/sku description: Retorna os dados gerais do SKU skuComplemento: type: object allOf: – #/definitions/skuComplemento description: Retorna o complemento do SKU skusSubstituido: type: array items: type: object allOf: – #/definitions/skuSubstituido description: Skus substituídos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/gravarCategoria: post: description: Cria ou altera dados de uma categoria tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId – descricao properties: id: type: string description: Id do registro em caso de alteração, null se criação nova categoria empresaId: type: integer format: int64 description: Id da empresa a qual a categoria pertencerá descricao: type: string maxLength: 40 description: Nome da categoria complemento: type: string maxLength: 250 description: Descrição complementar da categoria categoriaPaiId: type: string maxLength: 36 description: Id da categoria pai, null se categoria raíz responses: 200: description: Ok schema: type: object required: – categoria properties: categoria: type: object allOf: – #/definitions/categoria description: Retorna os dados da categoria 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/excluirCategoria: post: description: Exclui uma categoria tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – categoriaId properties: categoriaId: type: string maxLength: 36 description: ID da categoria responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: boolean description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/excluirSkuEquivalente: post: description: Exclui tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: skuEquivalenteId: type: string maxLength: 36 description: ID da ligação Sku/Equivalente skuId: type: integer format: int64 description: Id do SKU responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: boolean description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/enviarSku: post: description: Envia cadastro do SKU para G5 tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operacao – skuId properties: operacao: type: string allOf: – #/definitions/enumOperacao description: Operação a ser efetuada skuId: type: integer format: int64 description: Id do SKU a ser enviado responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/gravarCategoriaSku: post: description: Grava ligação SKU com Categoria tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – skuCategoria properties: skuCategoria: type: object allOf: – #/definitions/recCategoriaSku description: Ligação SKU com Categoria – Se não for enviada categoriaId, sera desvinculado o SKU de sua categoria responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: boolean description: Retorno da gravação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/gravarParametrosUsuario: post: description: Grava os parâmetros de usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – usuario properties: id: type: integer format: int64 description: ID dos parâmetros codigoEmpresa: type: integer format: int64 description: Empresa para gravar parâmetros usuario: type: string description: Usuário para gravar parâmetros requisicaoExibirUsuarioAtivo: type: string allOf: – #/definitions/enumSimNao description: Indicativo se exibe somente requisições do usuário ativo centroCusto: type: object allOf: – #/definitions/recCentroCusto description: Centro de custo padrão tipoNotificacaoTramite: type: string allOf: – #/definitions/enumTipoNotificacaoTramite description: Tipo de notificação para os trâmites do item da requisição/necessidade de compra responses: 200: description: Ok schema: type: object required: – id properties: id: type: integer format: int64 description: ID do registro gravado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/gravarParametrizacaoFilial: post: description: Grava os parâmetros gerais da empresa/filial tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – parametrizacao properties: id: type: integer format: int64 description: Identificador codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Código da filial parametrizacao: type: object allOf: – #/definitions/recParametrizacaoFilialGravar description: Parametrizações da filial responses: 200: description: Ok schema: type: object required: – id properties: id: type: integer format: int64 description: Identificador da parametrização da filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/definirNumeracaoRequisicao: post: description: Defini a numeração da requisição tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – proximoNumeroRequisicao properties: codigoEmpresa: type: integer format: int64 description: Código da empresa proximoNumeroRequisicao: type: integer format: int64 description: Número da requisição exigeSkuEnvioRequisicao: type: boolean description: Indicativo se permitirá o envio de requisições sem um SKU informado, ou seja, só descrição do complemento informada. responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: boolean description: Retorno do número da requisição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importEstado: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importCidade: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importMarca: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importCategoria: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importSkuImagem: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importContaContabil: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importContaFinanceira: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importCentroCusto: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importProjeto: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importFase: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importSkuSubstituido: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importNumeracaoRequisicao: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importRelacionamentoContaFinanc: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importRelacionamentoContaContabil: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importRelacionamentoCentroCusto: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importRelacionamentoProjeto: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importRelaciProjetoContafinanceira: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importRelacionamProjetoCentrocusto: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importParametrosUsuario: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importFilialEndereco: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importParametrizacao: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importSkuFilial: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/actions/importSkuFilialFornecedor: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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 401: description: Invalid Credentials 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 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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 401: description: Invalid Credentials 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 401: description: Invalid Credentials 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 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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 401: description: Invalid Credentials 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 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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 401: description: Invalid Credentials 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 401: description: Invalid Credentials 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 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/estado: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/estado responses: 200: description: The created resource schema: #/definitions/estado 401: description: Invalid Credentials 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/estado responses: 200: description: The created resource schema: #/definitions/estado 401: description: Invalid Credentials 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/estado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/estado/{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/estado responses: 200: description: Ok schema: #/definitions/estado 401: description: Invalid Credentials 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/estado responses: 200: description: Ok schema: #/definitions/estado 401: description: Invalid Credentials 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/estado 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/estado/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/estado responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/familia: 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/familia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/cidade: 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/cidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/marca: 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/marca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/categoria: 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/categoria 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/sku: 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/sku 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/skuImagem: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/skuImagem responses: 200: description: The created resource schema: #/definitions/skuImagem 401: description: Invalid Credentials 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/skuImagem responses: 200: description: The created resource schema: #/definitions/skuImagem 401: description: Invalid Credentials 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/skuImagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/skuImagem/{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/skuImagem responses: 200: description: Ok schema: #/definitions/skuImagem 401: description: Invalid Credentials 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/skuImagem responses: 200: description: Ok schema: #/definitions/skuImagem 401: description: Invalid Credentials 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/skuImagem 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/skuImagem/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/skuImagem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/skuComplemento: 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/skuComplemento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/sku/{parentId}/skuComplemento: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/skuComplemento responses: 200: description: The created resource schema: #/definitions/skuComplemento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/skuComplemento responses: 200: description: The created resource schema: #/definitions/skuComplemento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/skuComplemento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/sku/{parentId}/skuComplemento/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/skuComplemento responses: 200: description: Ok schema: #/definitions/skuComplemento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/skuComplemento responses: 200: description: Ok schema: #/definitions/skuComplemento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/skuComplemento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/contaContabil: 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/contaContabil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/contaFinanceira: 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/contaFinanceira 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/centroCusto: 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/centroCusto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/projeto: 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/projeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/fase: 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/fase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/unidadeMedida: 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/skuSubstituido: 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/skuSubstituido 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/numeracaoRequisicao: 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/numeracaoRequisicao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/relacionamentoContaFinanc: 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/relacionamentoContaFinanc 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/relacionamentoContaContabil: 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/relacionamentoContaContabil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/relacionamentoCentroCusto: 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/relacionamentoCentroCusto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/relacionamentoProjeto: 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/relacionamentoProjeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/relaciProjetoContafinanceira: 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/relaciProjetoContafinanceira 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/relacionamProjetoCentrocusto: 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/relacionamProjetoCentrocusto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/parametrosUsuario: 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/parametrosUsuario 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/filialEndereco: 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/filialEndereco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/parametrizacao: 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/parametrizacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/deposito: 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/fornecedor: 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/skuFilial: 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/skuFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /com_comum/entities/skuFilialFornecedor: 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/skuFilialFornecedor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumSituacaoFase: description: Enumeração para Ativo/Inativo/Automático type: string enum: – ATIVO – INATIVO – AUTOMATICO enumTipoFase: description: Enumerador de tipo de fase de projeto type: string enum: – ANALITICA – SINTETICA enumOperacao: description: Enumerador de operação de integração type: string enum: – Insercao – Atualizacao – Exclusao enumSituacaoProjeto: description: Enumerador Situação Projeto type: string enum: – ANA – APR – INA enumAtivoInativo: description: Enumeração para Ativo/Inativo type: string enum: – Ativo – Inativo enumSituacaoSku: description: Enumeração para Situacao SKU type: string enum: – Ativo – Inativo – Bloqueado enumSituacaoEndereco: description: Enumerador da situação do endereco de entrega ou faturamento type: string enum: – Ativo – Inativo – Bloqueado enumSimNao: description: Enumeração para Ativo/Inativo type: string enum: – Sim – Nao enumTipoNotificacaoTramite: description: Enumeração para o tipo da notificação do trâmite do item da requisição/necessidade de compra type: string enum: – Email – Plataforma enumSituacaoMarca: description: Enumeração da situação da marca type: string enum: – ATIVO – INATIVO enumTipoLigacaoSkuFilialFornecedor: description: Tipo de Ligacao do SkuFilialFornecedor type: string enum: – Nenhum – Exclusivo – Sugerido enumTipoConta: description: Enumeração para tipo de conta type: string enum: – Analitico – Sintetico enumNaturezaConta: description: Enumeração para Credora/Devedora type: string enum: – Credora – Devedora enumTipoSKU: description: Enumerador de tipo de SKU type: string enum: – NaoClassificado – Mercadoria – MateriaPrima – Intermediario – Embalagem – Manufatura – EmFabricacao – Subproduto – UsoCosumo – AtivoImobilizado – Servico – OutrosInsumos – Outros enumTipoRequisicaoPadrao: description: Tipo Requisição Padrão type: string enum: – UsoConsumo – TransferenciaDepositos – Devolucao enumTipoReposicaoSKU: description: Enumeração para tipo de reposição do SKU type: string enum: – Produzido – Comprado – Servico enumTipoQualidadeSKU: description: Enumeração para tipo de reposição do SKU type: string enum: – Normal – Refugo – SegundaQualidade – TerceiraQualidade enumFornecedorTipo: description: Tipo de fornecedor type: string enum: – PESSOA_JURIDICA – PESSOA_FISICA enumTipoEndereco: description: Tipo de endereço type: string enum: – ENTREGA – FATURAMENTO enumIntervaloCalculoConsumo: description: Enumerador de Intervalo de consumo type: string enum: – Dia – Semana – Mes – Ano enumCurvaAbc: description: Enumerador de curvas type: string enum: – A – B – C – D enumTipoCompra: description: Enumerador de tipo de compra type: string enum: – CompraDireta – Transferencia – CompraPeloCD enumSituacaoImagemSku: description: Enumerador da situação do cadastro de imagens do sku type: string enum: – Ativo – Inativo – Pendente – EmImportacao – Concluido – Erro enumTipoProduto: description: Tipo de Produto type: string enum: – COMPRADO – PASSAGEMDIRETA – MONTAGEM – PRODUZIDO – SERVICO enumSituacaoDeposito: description: Enumeração para Situacao do depósito type: string enum: – ATIVO – INATIVO – BLOQUEADO 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 recDeposito: description: Dados do depósito type: object required: – id – empresa – filial – codigo – descricao – abreviatura properties: id: type: integer format: int64 description: Identificador único empresa: type: object allOf: – #/definitions/recEmpresa description: Código Empresa filial: type: object allOf: – #/definitions/recFilial description: Código Filial codigo: type: string description: Código do depósito descricao: type: string description: Descrição do depósito abreviatura: type: string description: Abreviatura do depósito recDepositoSaldoEstoque: description: Dados do depósito com saldo estoque type: object required: – id – empresa – filial – codigo – descricao – idSku – qtdDisponivelFaturamento properties: id: type: integer format: int64 description: Identificador único empresa: type: object allOf: – #/definitions/recEmpresa description: Código Empresa filial: type: object allOf: – #/definitions/recFilial description: Código Filial codigo: type: string description: Código do depósito descricao: type: string description: Descrição do depósito idSku: type: integer format: int64 description: SKU pesquisado qtdDisponivelFaturamento: type: number format: double description: Quantidade em estoque do SKU no depósito recParametrosComprasEmAndamento: description: Dados do parâmetro de cálculo de compras que estão em andamento type: object required: – codigoEmpresa – codigoDeposito – codigoSku properties: codigoEmpresa: type: integer format: int64 description: Código da empresa para calcular as compras em andamento codigoDeposito: type: string description: Depósito para calcular as compras em andamento codigoSku: type: string description: Produto para pesquisar as compras em andamento recComprasEmAndamento: description: Dados das compras que estão em andamento type: object required: – codigoEmpresa – codigoDeposito – codigoSku – quantidade properties: codigoEmpresa: type: integer format: int64 description: Código da empresa pesquisada codigoDeposito: type: string description: Depósito pesquisado codigoSku: type: string description: Produto pesquisado quantidade: type: number format: double description: Quantidade localizada do SKU em compras em andamento recCategoriaSku: description: Dados da representação de SKU/Categoria type: object required: – skuId properties: skuId: type: array items: type: integer format: int64 minimum: 1 description: Id do Sku categoriaId: type: string description: Id da categoria 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 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 recMarca: description: Dados da marca type: object required: – codigo – nome properties: id: type: string description: Identificador único codigo: type: string maxLength: 10 description: Código da marca nome: type: string maxLength: 40 description: Nomar da marca situacao: type: string allOf: – #/definitions/enumSituacaoMarca description: Situacao da marca dataGeracao: type: string format: date-time description: Data de geração usuarioGeracao: type: string description: Usuário de geração dataAlteracao: type: string format: date-time description: Data de alteração usuarioAlteracao: type: string description: Usuário de alteração codigoEmpresa: type: integer format: int64 description: Código da empresa em que foi cadastrada a marca nomeEmpresa: type: string description: Nome da empresa em que foi cadastrada a marca recSkuCriterios: description: Dados retornados pela pesquisa de SKUs/depósitos type: object required: – codigoEmpresa – codigoSku properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoSku: type: string description: Código do SKU codigoCategoria: type: string description: Código da categoria codigoMarca: type: string description: Código da marca descricaoMarca: type: string description: Descrição da marca descricaoCategoria: type: string description: Descrição da categoria recCategoria: description: Dados da categoria type: object required: – empresa – codigo – descricao properties: id: type: string description: Identificador único empresa: type: object allOf: – #/definitions/recEmpresa description: Empresa codigo: type: string maxLength: 10 description: Código da categoria descricao: type: string maxLength: 40 description: Nome da marca complemento: type: string maxLength: 250 description: Nivel da categoria categoriaPai: type: string maxLength: 36 description: Categoria pai hierarquia: type: string maxLength: 100 description: Hierarquia da categoria até o nó raiz recCategoriaEntidade: description: Dados da categoria type: object required: – empresaId – codigo – descricao properties: id: type: string description: Identificador único empresaId: type: object allOf: – #/definitions/recEmpresa description: Identificador único da empresa codigo: type: string maxLength: 10 description: Código da categoria descricao: type: string maxLength: 40 description: Nome da categoria complemento: type: string maxLength: 250 description: Descrição complementar da categoria categoriaPaiId: type: object allOf: – #/definitions/recCategoriaEntidade description: Categoria pai hierarquia: type: string maxLength: 100 description: Hierarquia da categoria até o nó raiz recNoCategoria: description: Estrutura de dados representando um nó na árvore de categorias type: object required: – id – codigo – descricao properties: id: type: string description: Identificador único codigo: type: string maxLength: 10 description: Código da categoria descricao: type: string maxLength: 40 description: Nome da categoria complemento: type: string maxLength: 250 description: Descrição da categoria subcategorias: type: array items: type: object allOf: – #/definitions/recNoCategoria description: Categorias filhas recSku: description: Dados do SKU – Produtos/Serviços type: object required: – empresa properties: id: type: integer format: int64 description: Identificador único empresa: type: object allOf: – #/definitions/recEmpresa description: Empresa codigo: type: string description: Código do SKU descricao: type: string description: Descrição do SKU descricaoComplementar: type: string description: Descrição complementar do SKU tipoProduto: type: string allOf: – #/definitions/enumTipoSKU description: Tipo do SKU tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicaoSKU description: Tipo de reposição do SKU tipoQualidade: type: string allOf: – #/definitions/enumTipoQualidadeSKU description: Tipo de qualidade do SKU unidadeMedida: type: object allOf: – #/definitions/recUnidadeMedida description: Unidade de medida familia: type: object allOf: – #/definitions/recFamilia description: Familia situacao: type: string allOf: – #/definitions/enumSituacaoSku description: Situação do SKU contaContabil: type: object allOf: – #/definitions/recContaContabil description: Conta contábil padrão marca: type: object allOf: – #/definitions/recMarca description: Marca skuSubstituto: type: object allOf: – #/definitions/sku description: Produto Substituto skuSubstituidos: type: array items: type: object allOf: – #/definitions/skuSubstituido description: Lista de Sku Substituido skuEquivalenteParaCalculo: type: object allOf: – #/definitions/sku description: Produto equivalente para calculo categoria: type: object allOf: – #/definitions/recCategoria description: Categoria permiteRequisitar: type: string allOf: – #/definitions/enumSimNao description: Identifica se o produto pode ser requisitado permiteComprar: type: string allOf: – #/definitions/enumSimNao description: Identifica se o produto pode ser comprado urlAnexo: type: string description: Url do anexo de imagem vinculado ao sku recSkuEntidade: description: record da entidade SKU – produto/serviço type: object required: – empresaId – codigo – descricao – tipoProduto – familiaId – situacao properties: id: type: integer format: int64 description: Identificador único, deve ser informado nas operações de atualização e exclusão empresaId: type: object allOf: – #/definitions/recEmpresa description: Identificador único da empresa codigo: type: string maxLength: 30 description: Código descricao: type: string maxLength: 250 description: Descrição descricaoComplementar: type: string maxLength: 250 description: Descrição complementar tipoProduto: type: string allOf: – #/definitions/enumTipoSKU description: Tipo de produto familiaId: type: object allOf: – #/definitions/recFamiliaEntidade description: Identificador único da familia unidadeMedidaIdCompras: type: object allOf: – #/definitions/recUnidadeMedida description: Identificador único da unidade de medida para compras situacao: type: string allOf: – #/definitions/enumSituacaoSku description: Situação marcaId: type: object allOf: – #/definitions/recMarca description: Marca categoriaId: type: object allOf: – #/definitions/recCategoriaEntidade description: Categoria permiteRequisitar: type: string allOf: – #/definitions/enumSimNao description: Identifica se o produto pode ser requisitado permiteComprar: type: string allOf: – #/definitions/enumSimNao description: Identifica se o produto pode ser comprado skuSubstituidos: type: array items: type: object allOf: – #/definitions/skuSubstituidoEntidade description: Lista de skus substituídos skuEquivalenteParaCalculo: type: object allOf: – #/definitions/recSkuEntidade description: Sku equivalente utilizado para cálculo recSkuSubstituto: description: Record skuSubstituido type: object required: – skuPaiId – skuPaiCodigo – codigoEmpresa properties: skuPaiId: type: integer format: int64 description: Sku que originou a consulta a esse record skuPaiCodigo: type: string description: Codigo sku pai codigoEmpresa: type: string description: Empresa sku pai skuSubstituto: type: object allOf: – #/definitions/sku description: Produto Substituto skusSubstituidos: type: array items: type: object allOf: – #/definitions/skuSubstituido description: Lista de Sku Substituido skuEquivalenteParaCalculo: type: object allOf: – #/definitions/sku description: Produto equivalente para calculo skuSubstituidoEntidade: description: Entidade Sku substituído type: object required: – skuSubstituido – utilizaCalculoConsumo properties: id: type: string description: Identificador único sku: type: object allOf: – #/definitions/recSkuEntidade description: Identificador único do SKU skuSubstituido: type: object allOf: – #/definitions/recSkuEntidade description: Idenficador único do SKU Substituído utilizaCalculoConsumo: type: boolean description: Utilizar cálculo de consumo substituído recSkuPorCodigo: description: Record sku pelo codigo e id de empresa type: object required: – codigo – empresa properties: codigo: type: string description: Codigo do sku empresa: type: integer format: int64 description: Codigo da empresa recSkuComplemento: description: Complemento do SKU type: object required: – skuId properties: id: type: integer format: int64 description: Identificador único skuId: type: object allOf: – #/definitions/recSku description: Identificador único do SKU skuIdSegunda: type: object allOf: – #/definitions/recSku description: Identificador único do SKU para segunda qualidade skuIdTerceira: type: object allOf: – #/definitions/recSku description: Identificador único do SKU para terceira qualidade skuIdRefugo: type: object allOf: – #/definitions/recSku description: Identificador único do SKU para refugo tipoQualidade: type: string allOf: – #/definitions/enumTipoQualidadeSKU description: Tipo de Qualidade quantidadeMinimaCompra: type: number format: double description: Quantidade minima para compra quantidadeMaximaCompra: type: number format: double description: Quantidade maxima para compra quantidadeMultiplaCompra: type: number format: double description: Quantidade multipla para compra dataGeracao: type: string format: date-time description: Data de geração usuarioGeracao: type: string description: Usuário de geração dataAlteracao: type: string format: date-time description: Data de alteração usuarioAlteracao: type: string description: Usuário de alteração recSkuComplementoEntidade: description: Complemento do SKU type: object required: – skuId properties: id: type: integer format: int64 description: Identificador único skuId: type: object allOf: – #/definitions/recSkuEntidade description: Identificador único do SKU skuIdSegunda: type: object allOf: – #/definitions/recSkuEntidade description: Identificador único do SKU para segunda qualidade skuIdTerceira: type: object allOf: – #/definitions/recSkuEntidade description: Identificador único do SKU para terceira qualidade skuIdRefugo: type: object allOf: – #/definitions/recSkuEntidade description: Identificador único do SKU para refugo tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicaoSKU description: Tipo de reposição tipoQualidade: type: string allOf: – #/definitions/enumTipoQualidadeSKU description: Tipo de Qualidade quantidadeMinimaCompra: type: number format: double description: Quantidade minima para compra quantidadeMaximaCompra: type: number format: double description: Quantidade maxima para compra quantidadeMultiplaCompra: type: number format: double description: Quantidade multipla para compra recUnidadeMedida: description: Dados da unidade de medida type: object required: – id 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 recFamilia: description: Dados da familia type: object required: – id – codigo – descricao – empresa properties: id: type: integer format: int64 description: Identificador único codigo: type: string description: Código da familia descricao: type: string description: Descrição da familia empresa: type: object allOf: – #/definitions/recEmpresa description: Empresa da família tipoProduto: type: string allOf: – #/definitions/enumTipoProduto description: Tipo Produto recFamiliaEntidade: description: Dados da familia type: object required: – empresaId – codigo – descricao properties: id: type: integer format: int64 description: Identificador único empresaId: type: object allOf: – #/definitions/recEmpresa description: Identificador único da empresa codigo: type: string maxLength: 10 description: Código da familia descricao: type: string maxLength: 30 description: Descrição da familia contaContabilId: type: object allOf: – #/definitions/recContaContabilEntidade description: Identificador único da conta contabil recContaContabilEntidade: description: Dados da conta contábil type: object required: – empresaId – codigo – descricao – abreviatura – mascara – classificacao – tipo – situacao – natureza properties: id: type: integer format: int64 description: Identificador único empresaId: type: object allOf: – #/definitions/recEmpresa description: Identificador único da empresa contaContabilPaiId: type: integer format: int64 description: Identificador único da conta contabil pai codigo: type: integer format: int64 description: Código mascarado da conta contábil descricao: type: string maxLength: 250 description: Descrição da conta contábil abreviatura: type: string maxLength: 20 description: Abreviatura da conta contábil mascara: type: string maxLength: 40 description: Mascara da conta contabil codigoMascarado: type: string maxLength: 50 description: Codigo mascarado da conta contabil classificacao: type: string maxLength: 30 description: Classificação da conta contabil nivel: type: integer format: int64 description: Nível da conta contábil posicoesNivel: type: integer format: int64 description: Posições nível da conta contábil tipo: type: string allOf: – #/definitions/enumTipoConta description: Tipo da conta contábil situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação da conta contábil natureza: type: string allOf: – #/definitions/enumNaturezaConta description: Natureza da conta contábil recContaContabil: description: Dados da conta contábil type: object required: – mascara – classificacao 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 abreviatura: type: string description: abreviatura da conta contábil tipo: type: string allOf: – #/definitions/enumTipoConta description: Tipo da conta contábil situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação da conta contábil natureza: type: string allOf: – #/definitions/enumNaturezaConta description: Natureza da conta contábil mascara: type: string description: Mascara da conta contabil classificacao: type: string description: Classificação da conta contabil 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 recFornecedor: description: Cadastro do fornecedor type: object required: – cnpjcpf – codigo – nome properties: id: type: integer format: int64 description: Identificador único, deve ser informado nas operações de atualização e exclusão cnpjcpf: type: string description: CNPJ/CPF codigo: type: string description: Código do fornecedor nome: type: string description: Nome tipo: type: string allOf: – #/definitions/enumFornecedorTipo description: Tipo do fornecedor recLigacaoSkuFilial: description: Ligação Sku/filial type: object required: – sku – empresa – filial – tipo_compra properties: id: type: string maxLength: 36 description: Identificador único sku: type: object allOf: – #/definitions/recSku description: Identificador único da SKU empresa: type: object allOf: – #/definitions/recEmpresa description: Identificador único da empresa filial: type: object allOf: – #/definitions/recFilial description: Identificador único da Filial curva_abc: type: string allOf: – #/definitions/enumCurvaAbc description: Indicativo da classe ABC do produto em relação a filial intervalo_calc_consumo: type: string allOf: – #/definitions/enumIntervaloCalculoConsumo description: Tipo de intervalo de período para o cálculo de consumo quantidade_calc_consumo: type: integer format: int64 description: Quantidade de períodos do intervalo tipo_compra: type: string allOf: – #/definitions/enumTipoCompra description: Tipo de Compra recLigacaoSkuFilialFornecedor: description: Ligação SkuFilial/Fornecedor type: object required: – empresaId – fornecedor – prazo_entrega – tipo_ligacao – situacao – tipo_compra – curva_abc – confirmaNecessidadeAutomaticamente properties: id: type: string maxLength: 36 description: Identificador único empresaId: type: object allOf: – #/definitions/recEmpresa description: Identificador único da empresa skuFilial: type: object allOf: – #/definitions/recLigacaoSkuFilial description: Identificador único da ligacao Sku/Filial fornecedor: type: object allOf: – #/definitions/recFornecedor description: Identificador único do fornecedor codigo_sku_fornecedor: type: string maxLength: 30 description: Código do SKU no fornecedor prazo_entrega: type: integer format: int64 description: Prazo de entrega tipo_ligacao: type: string allOf: – #/definitions/enumTipoLigacaoSkuFilialFornecedor description: Indicativo do tipo do fornecedor, se é exclusivo, sugerido ou nenhum para o produto na filial situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Indicativo se a ligação está ativa tipo_compra: type: string allOf: – #/definitions/enumTipoCompra description: Tipo de Compra quantidade_minima: type: number format: double description: Quantidade mínima quantidade_maxima: type: number format: double description: Quantidade máxima quantidade_multipla: type: number format: double description: Quantidade múltipla curva_abc: type: string allOf: – #/definitions/enumCurvaAbc description: Indicativo da classe ABC do produto em relação a filial e ao fornecedor confirmaNecessidadeAutomaticamente: type: string allOf: – #/definitions/enumSimNao description: Indicativo se confirma a necessidade de compra automáticamente recParametrosBuscaLigacaoSkuFornecedor: description: Parâmetros para busca da ligação SKU x Fornecedor type: object required: – codigoEmpresa – codigoFilial – codigoSku properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Código da filial codigoSku: type: string description: Código do SKU recLigacaoSkuFornecedor: description: Dados de ligação do SKU com fornecedor type: object required: – codigoEmpresa – codigoFilial – sku – fornecedores properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Código da filial sku: type: string description: Produto fornecedores: type: array items: type: object allOf: – #/definitions/recFornecedoresSku minimum: 1 description: Fornecedores ligados ao sku recFornecedoresSku: description: Dados dos fornecedores do SKU para reposição type: object required: – codigoFornecedor – nomeFornecedor properties: codigoFornecedor: type: integer format: int64 description: Código do fornecedor nomeFornecedor: type: string description: Nome do fornecedor prazoEntrega: type: integer format: int64 description: Prazo de entrega do fornecedor (em dias) recProjeto: description: Dados do projeto type: object required: – id – numero – nome – abreviatura – situacao 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 abreviatura: type: string maxLength: 20 description: Abreviatura situacao: type: string maxLength: 3 description: Situação 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 abreviatura: type: string description: Abreviatura da conta financeira tipo: type: string allOf: – #/definitions/enumTipoConta description: Tipo da conta financeira situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação da conta financeira natureza: type: string allOf: – #/definitions/enumNaturezaConta description: Natureza da conta financeira 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 abreviatura: type: string description: Abreviatura do centro de custo mascara: type: string description: Máscara do centro de custo tipo: type: string allOf: – #/definitions/enumTipoConta description: Tipo do centro de custo situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação do centro de custo recFase: description: Dados do fase type: object required: – id – codigo – descricao – abreviatura – aceita_rateio – situacao – projeto 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 abreviatura: type: string maxLength: 20 description: Abreviatura aceita_rateio: type: string allOf: – #/definitions/enumSimNao description: Define se aceita rateio situacao: type: string allOf: – #/definitions/enumSituacaoFase description: Situacao projeto: type: object allOf: – #/definitions/recProjeto description: Projeto da fase fasePai: type: integer format: int64 description: Código da fase pai tipo: type: string allOf: – #/definitions/enumTipoFase description: Tipo de fase (sintética ou analítica) recParametrizacaoFilialBusca: description: Parametros da filial utilizado na busca type: object properties: id: type: integer format: int64 description: Id do registro de parametrização contaFinanceiraRequisicao: type: object allOf: – #/definitions/recContaFinanceira description: Conta financeira padrão para lançamento de requisições contaContabilObrigatoriaRequisicao: type: string allOf: – #/definitions/enumSimNao description: Indicativo conta contabil obrigatória na requisição contaFinanceiraObrigatoriaRequisicao: type: string allOf: – #/definitions/enumSimNao description: Indicativo conta financeira obrigatória na requisição exibirBem: type: string allOf: – #/definitions/enumSimNao description: Indicativo se exibe o bem na requisição exibirEnderecoEntregaFaturamento: type: string allOf: – #/definitions/enumSimNao description: Indicativo se exibe o endereço de entrega e de faturamento exibirProjetoFaseRequisicao: type: string allOf: – #/definitions/enumSimNao description: Indicativo se exibe projeto/fase na requisição projeto: type: object allOf: – #/definitions/recProjeto description: Projeto padrão para lançamento de requisições fase: type: object allOf: – #/definitions/recFase description: Fase padrão para lançamento de requisição enderecoEntrega: type: object allOf: – #/definitions/recFilialEndereco description: Endereço de entrega enderecoFaturamento: type: object allOf: – #/definitions/recFilialEndereco description: Endereço do faturamento recParametrizacaoFilialGravar: description: Parametros da filial utilizado na gração type: object properties: id: type: integer format: int64 description: Id do registro de parametrização contaContabilObrigatoriaRequisicao: type: string allOf: – #/definitions/enumSimNao description: Indicativo conta contabil obrigatória na requisição contaFinanceiraObrigatoriaRequisicao: type: string allOf: – #/definitions/enumSimNao description: Indicativo conta financeira obrigatória na requisição exibirBem: type: string allOf: – #/definitions/enumSimNao description: Indicativo se exibe o bem na requisição exibirEnderecoEntregaFaturamento: type: string allOf: – #/definitions/enumSimNao description: Indicativo se exibe o endereço de entrega e de faturamento exibirProjetoFaseRequisicao: type: string allOf: – #/definitions/enumSimNao description: Indicativo se exibe projeto/fase na requisição contaFinanceiraId: type: integer format: int64 description: Identificador da conta financeira padrão para lançamento projetoId: type: integer format: int64 description: Identificador do projeto padrão para lançamento faseId: type: integer format: int64 description: Idetificador da fase padrão para lançamento enderecoEntregaId: type: integer format: int64 description: Identificador do endereço de entrega enderecoFaturamentoId: type: integer format: int64 description: Identificador do endereço do faturamento recFilialEndereco: description: Dados do endereço de entrega ou de faturamento 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 recParametrosUsuario: description: Dados do parametros usuário type: object required: – id – empresa – nome properties: id: type: integer format: int64 description: Identificador único empresa: type: object allOf: – #/definitions/empresa description: Empresa centroCusto: type: object allOf: – #/definitions/recCentroCusto description: Centro de custo nome: type: string description: Nome do usuário requisicaoExibirUsuarioAtivo: type: string allOf: – #/definitions/enumSimNao description: Indicativo se exibe somente requisições do usuário ativo tipoNotificacaoTramite: type: string allOf: – #/definitions/enumTipoNotificacaoTramite description: Tipo de notificação para os trâmites do item da requisição/necessidade de compra 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 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 cnpjCpf: type: string description: CPF/CNPJ usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: estado: description: Estado type: object required: – codigo – descricao – abreviatura properties: id: type: integer format: int64 description: Identificador único, deve ser informado nas operações de atualização e exclusão codigo: type: string description: Código descricao: type: string description: Descrição abreviatura: type: string description: Abreviatura usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: familia: description: Dados da familia type: object required: – empresaId – codigo – descricao properties: id: type: integer format: int64 description: Identificador único empresaId: type: object allOf: – #/definitions/empresa description: Identificador único da empresa codigo: type: string maxLength: 10 description: Código da familia descricao: type: string maxLength: 30 description: Descrição da familia contaContabilId: type: object allOf: – #/definitions/contaContabil description: Identificador único da conta contabil tipoProduto: type: string allOf: – #/definitions/enumTipoProduto description: Tipo Produto situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: cidade: description: Cidade type: object required: – codigo – descricao – estado properties: id: type: integer format: int64 description: Identificador único codigo: type: string description: Código descricao: type: string description: Descrição estado: type: object allOf: – #/definitions/estado description: Estado usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: marca: description: Dados da marca type: object required: – empresa – codigo – nome properties: id: type: string format: uuid description: Identificador único empresa: type: object allOf: – #/definitions/empresa description: Empresa codigo: type: string maxLength: 10 description: Código da marca nome: type: string maxLength: 40 description: Nomar da marca situacao: type: string allOf: – #/definitions/enumSituacaoMarca description: Situacao da marca usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: categoria: description: Dados da categoria type: object required: – empresaId – codigo – descricao properties: id: type: string format: uuid description: Identificador único empresaId: type: object allOf: – #/definitions/empresa description: Identificador único da empresa codigo: type: string maxLength: 10 description: Código da categoria descricao: type: string maxLength: 40 description: Nome da categoria complemento: type: string maxLength: 250 description: Descrição complementar da categoria categoriaPaiId: type: object allOf: – #/definitions/categoria description: Categoria pai hierarquia: type: string maxLength: 100 description: Hierarquia da categoria até o nó raiz usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: sku: description: SKU – produto/serviço type: object required: – empresaId – codigo – descricao – tipoProduto – familiaId – situacao properties: id: type: integer format: int64 description: Identificador único, deve ser informado nas operações de atualização e exclusão empresaId: type: object allOf: – #/definitions/empresa description: Identificador único da empresa codigo: type: string maxLength: 30 description: Código descricao: type: string maxLength: 250 description: Descrição descricaoComplementar: type: string maxLength: 250 description: Descrição complementar tipoProduto: type: string allOf: – #/definitions/enumTipoSKU description: Tipo de produto familiaId: type: object allOf: – #/definitions/familia description: Identificador único da familia unidadeMedidaIdCompras: type: object allOf: – #/definitions/unidadeMedida description: Identificador único da unidade de medida para compras situacao: type: string allOf: – #/definitions/enumSituacaoSku description: Situação marcaId: type: object allOf: – #/definitions/marca description: Marca categoriaId: type: object allOf: – #/definitions/categoria description: Categoria permiteRequisitar: type: string allOf: – #/definitions/enumSimNao description: Identifica se o produto pode ser requisitado permiteComprar: type: string allOf: – #/definitions/enumSimNao description: Identifica se o produto pode ser comprado skuSubstituidos: type: array items: type: object allOf: – #/definitions/skuSubstituido description: Lista de skus substituídos skuEquivalenteParaCalculo: type: object allOf: – #/definitions/sku description: Sku equivalente utilizado para cálculo skuComplemento: type: object allOf: – #/definitions/skuComplemento description: SKU complemento skuFiliais: type: array items: type: object allOf: – #/definitions/skuFilial description: SKU/Filiais usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: skuImagem: description: SKU – Imagem type: object required: – skuId – nomeArquivo – versaoArquivo – situacao properties: id: type: string format: uuid description: Identificador único skuId: type: object allOf: – #/definitions/sku description: Identificador único do SKU targetObject: type: string format: uuid description: TargetObject do arquivo necessario para o blobservice nomeArquivo: type: string maxLength: 100 description: Nome do arquivo versaoArquivo: type: string maxLength: 50 description: Versão do arquivo situacao: type: string allOf: – #/definitions/enumSituacaoImagemSku description: Situação logImportacao: type: string description: Log da importação do arquivo usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: skuComplemento: description: Complemento do SKU type: object properties: id: type: integer format: int64 description: Identificador único skuId: type: object allOf: – #/definitions/sku description: Identificador único do SKU skuIdSegunda: type: object allOf: – #/definitions/sku description: Identificador único do SKU para segunda qualidade skuIdTerceira: type: object allOf: – #/definitions/sku description: Identificador único do SKU para terceira qualidade skuIdRefugo: type: object allOf: – #/definitions/sku description: Identificador único do SKU para refugo tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicaoSKU description: Tipo de reposição tipoQualidade: type: string allOf: – #/definitions/enumTipoQualidadeSKU description: Tipo de Qualidade quantidadeMinimaCompra: type: number format: double description: Quantidade minima para compra quantidadeMaximaCompra: type: number format: double description: Quantidade maxima para compra quantidadeMultiplaCompra: type: number format: double description: Quantidade multipla para compra usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: contaContabil: description: Dados da conta contábil type: object required: – empresa – codigo – descricao – abreviatura – mascara – classificacao – tipo – situacao – natureza properties: id: type: integer format: int64 description: Identificador único empresa: type: object allOf: – #/definitions/empresa description: Empresa contaContabilPai: type: object allOf: – #/definitions/contaContabil description: Identificador único da conta contabil pai codigo: type: integer format: int64 description: Código mascarado da conta contábil descricao: type: string maxLength: 250 description: Descrição da conta contábil abreviatura: type: string maxLength: 20 description: Abreviatura da conta contábil mascara: type: string maxLength: 40 description: Mascara da conta contabil codigoMascarado: type: string maxLength: 50 description: Codigo mascarado da conta contabil classificacao: type: string maxLength: 30 description: Classificação da conta contabil nivel: type: integer format: int64 description: Nível da conta contábil posicoesNivel: type: integer format: int64 description: Posições nível da conta contábil tipo: type: string allOf: – #/definitions/enumTipoConta description: Tipo da conta contábil situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação da conta contábil natureza: type: string allOf: – #/definitions/enumNaturezaConta description: Natureza da conta contábil usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: contaFinanceira: description: Dados da Conta Financeira type: object required: – empresa – codigo – descricao – abreviatura – mascara – classificacao – tipo – situacao – natureza properties: id: type: integer format: int64 description: Identificador único empresa: type: object allOf: – #/definitions/empresa description: Empresa contaFinanceiraPai: type: object allOf: – #/definitions/contaFinanceira description: Conta Financeira pai contaContabil: type: object allOf: – #/definitions/contaContabil description: Conta Contabil codigo: type: integer format: int64 description: Código mascarado da Conta Financeira descricao: type: string maxLength: 250 description: Descrição da Conta Financeira abreviatura: type: string maxLength: 20 description: Abreviatura da Conta Financeira mascara: type: string maxLength: 40 description: Mascara da Conta Financeira codigoMascarado: type: string maxLength: 50 description: Codigo mascarado da Conta Financeira classificacao: type: string maxLength: 30 description: Classificação da Conta Financeira nivel: type: integer format: int64 description: Nível da Conta Financeira posicoesNivel: type: integer format: int64 description: Posições nível da Conta Financeira tipo: type: string allOf: – #/definitions/enumTipoConta description: Tipo da conta contábil situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação da Conta Financeira natureza: type: string allOf: – #/definitions/enumNaturezaConta description: Natureza da Conta Financeira usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: centroCusto: description: Dados do Centro de Custo type: object required: – empresa – codigo – descricao – abreviatura – mascara – tipo – situacao properties: id: type: integer format: int64 description: Identificador único empresa: type: object allOf: – #/definitions/empresa description: Empresa centroCustoPai: type: object allOf: – #/definitions/centroCusto description: Centro de Custo Pai codigo: type: string description: Código mascarado da Conta Financeira descricao: type: string maxLength: 250 description: Descrição do Centro de Custo abreviatura: type: string maxLength: 20 description: Abreviatura do Centro de Custo mascara: type: string maxLength: 40 description: Mascara do Centro de Custo codigoMascarado: type: string maxLength: 50 description: Codigo mascarado do Centro de Custo classificacao: type: string maxLength: 30 description: Classificação do Centro de Custo nivel: type: integer format: int64 description: Nível do Centro de Custo posicoesNivel: type: integer format: int64 description: Posições nível do Centro de Custo tipo: type: string allOf: – #/definitions/enumTipoConta description: Tipo do Centro de Custo situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação do Centro de Custo aceitaRateio: type: string allOf: – #/definitions/enumSimNao description: Aceita Rateio usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: projeto: description: Dados do Projeto type: object required: – empresa – numero – nome properties: id: type: integer format: int64 description: Identificador único empresa: type: object allOf: – #/definitions/empresa description: Empresa numero: type: integer format: int64 description: Número projeto nome: type: string maxLength: 150 description: Nome abreviatura: type: string maxLength: 20 description: Abreviatura situacao: type: string allOf: – #/definitions/enumSituacaoProjeto description: Situação suspensoPorOcorrencia: type: string allOf: – #/definitions/enumSimNao description: Suspenso por Ocorrencia movimentaQuandoSuspenso: type: string allOf: – #/definitions/enumSimNao description: Movimenta Quando Suspenso usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: fase: description: Fase type: object required: – fasePai – projeto – codigo – abreviatura – tipo – aceitaRateio – situacao – descricao properties: id: type: integer format: int64 description: Identificador do projeto fasePai: type: object allOf: – #/definitions/fase description: Fase Pai projeto: type: object allOf: – #/definitions/projeto description: Projeto codigo: type: integer format: int64 description: Código da fase abreviatura: type: string description: Abreviatura tipo: type: string allOf: – #/definitions/enumTipoFase description: Tipo Fase aceitaRateio: type: string allOf: – #/definitions/enumSimNao description: Aceita Rateio situacao: type: string allOf: – #/definitions/enumSituacaoFase description: Situação descricao: type: string maxLength: 100 description: Descrição da fase 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: skuSubstituido: description: Entidade Sku substituído type: object required: – skuSubstituido – utilizaCalculoConsumo properties: id: type: string format: uuid description: Identificador único sku: type: object allOf: – #/definitions/sku description: Identificador único do SKU skuSubstituido: type: object allOf: – #/definitions/sku description: Idenficador único do SKU Substituído utilizaCalculoConsumo: type: boolean description: Utilizar cálculo de consumo substituído usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: numeracaoRequisicao: description: Numeração da requisição type: object required: – empresa – proximoNumero properties: id: type: integer format: int64 description: Identificador único empresa: type: object allOf: – #/definitions/empresa description: Empresa proximoNumero: type: integer format: int64 description: Próxima numeração exigeSkuEnvioRequisicao: type: boolean description: Indicativo se permite o envio de requisições para aprovação sem um SKU informado no item da requisição. usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: relacionamentoContaFinanc: description: Relacionamento Usuário x Conta Financeira type: object required: – empresa – contaFinanceira – usuario properties: id: type: string format: uuid description: Identificador Único empresa: type: object allOf: – #/definitions/empresa description: Empresa contaFinanceira: type: object allOf: – #/definitions/contaFinanceira description: Conta Financeira usuario: type: string description: Usuário criterio: type: integer format: int64 description: Critério situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: relacionamentoContaContabil: description: Relacionamento Usuário x Conta Contabil type: object required: – empresa – contaContabil – usuario properties: id: type: string format: uuid description: Identificador Único empresa: type: object allOf: – #/definitions/empresa description: Empresa contaContabil: type: object allOf: – #/definitions/contaContabil description: Conta Contabil usuario: type: string description: Usuário criterio: type: integer format: int64 description: Critério situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: relacionamentoCentroCusto: description: Relacionamento Usuário x Centro Custo type: object required: – empresa – centroCusto – usuario properties: id: type: string format: uuid description: Identificador Único empresa: type: object allOf: – #/definitions/empresa description: Empresa centroCusto: type: object allOf: – #/definitions/centroCusto description: Centro Custo usuario: type: string description: Usuário criterio: type: integer format: int64 description: Critério situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: relacionamentoProjeto: description: Relacionamento Usuário x Projeto type: object required: – empresa – projeto – usuario properties: id: type: string format: uuid description: Identificador Único empresa: type: object allOf: – #/definitions/empresa description: Empresa projeto: type: object allOf: – #/definitions/projeto description: Projeto usuario: type: string description: Usuário situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: relaciProjetoContafinanceira: description: Relacionamento Projeto x Conta Financeira type: object required: – empresa – projeto – contaFinanceira properties: id: type: string format: uuid description: Identificador Único empresa: type: object allOf: – #/definitions/empresa description: Empresa projeto: type: object allOf: – #/definitions/projeto description: Projeto contaFinanceira: type: object allOf: – #/definitions/contaFinanceira description: Conta Financeira criterio: type: integer format: int64 description: Critério situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: relacionamProjetoCentrocusto: description: Relacionamento Projeto X Centro Custo type: object required: – empresa – projeto – centroCusto properties: id: type: string format: uuid description: Identificador Único empresa: type: object allOf: – #/definitions/empresa description: Empresa projeto: type: object allOf: – #/definitions/projeto description: Projeto centroCusto: type: object allOf: – #/definitions/centroCusto description: Centro Custo criterio: type: integer format: int64 description: Critério situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: parametrosUsuario: description: Parâmetros do usuário type: object required: – empresa – usuario properties: id: type: integer format: int64 description: Identificador único empresa: type: object allOf: – #/definitions/empresa description: Empresa usuario: type: string description: Usuário centroCusto: type: object allOf: – #/definitions/centroCusto description: Centro de custo codigoG5Usuario: type: integer format: int64 description: Código Usuario G5 tipo: type: string allOf: – #/definitions/enumTipoRequisicaoPadrao description: Tipo da Requisição Padrão requisicaoExibirAtivo: type: string allOf: – #/definitions/enumSimNao description: Requisição Exibir Usuario Ativo tipoNotificacaoTramite: type: string allOf: – #/definitions/enumTipoNotificacaoTramite description: Tipo Notificação Trâmite usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: filialEndereco: description: Dados do endereço da filial, sendo de entrega ou faturamento type: object required: – empresa – filial – sequencia – endereco – estado – cidade – cep – tipoEndereco – situacao properties: id: type: integer format: int64 description: Identificador único empresa: type: object allOf: – #/definitions/empresa description: Empresa filial: type: object allOf: – #/definitions/filial description: Filial sequencia: type: integer format: int64 description: Sequência endereco: type: string description: Endereço complemento: type: string description: Complemento estado: type: object allOf: – #/definitions/estado description: Estado cidade: type: object allOf: – #/definitions/cidade description: Cidade bairro: type: string description: Bairro cep: type: string description: CEP tipoEndereco: type: string allOf: – #/definitions/enumTipoEndereco description: Tipo do endereço situacao: type: string allOf: – #/definitions/enumSituacaoEndereco description: Situação usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: parametrizacao: description: Parametrização type: object required: – empresa – contaFinanceira – projeto – fase – exibirProjetoFaseRequisicao – exibirBem – contaContabilObrigatoriaRequisicao – contaFinanceiraObrigatoriaRequisicao – exibirEnderecoEntregaFaturamento properties: id: type: integer format: int64 description: Identificador único empresa: type: object allOf: – #/definitions/empresa description: Empresa filial: type: object allOf: – #/definitions/filial description: Filial enderecoEntrega: type: object allOf: – #/definitions/filialEndereco description: Endereço de entrega enderecoFaturamento: type: object allOf: – #/definitions/filialEndereco description: Endereço de faturamento contaFinanceira: type: object allOf: – #/definitions/contaFinanceira description: Conta Financeira projeto: type: object allOf: – #/definitions/projeto description: Projeto fase: type: object allOf: – #/definitions/fase description: Fase exibirProjetoFaseRequisicao: type: string allOf: – #/definitions/enumSimNao description: Exibir Projeto Fase Requisicao exibirBem: type: string allOf: – #/definitions/enumSimNao description: Exibir Bem contaContabilObrigatoriaRequisicao: type: string allOf: – #/definitions/enumSimNao description: Conta Contábil Obrigatória Requisição contaFinanceiraObrigatoriaRequisicao: type: string allOf: – #/definitions/enumSimNao description: Conta Financeira Obrigatória Requisição exibirEnderecoEntregaFaturamento: type: string allOf: – #/definitions/enumSimNao description: Exibir Endereço Entrega Faturamento 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: – empresa – filial – codigo – descricao – situacao properties: id: type: integer format: int64 description: Identificador único empresa: type: object allOf: – #/definitions/empresa description: Empresa filial: type: object allOf: – #/definitions/filial description: Filial codigo: type: string description: Código do depósito descricao: type: string description: Descrição do depósito situacao: type: string allOf: – #/definitions/enumSituacaoDeposito description: Situação 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: – nome – situacao – cnpjCpf properties: id: type: integer format: int64 description: Identificador único codigo: type: integer format: int64 description: Código nome: type: string description: Nome situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação cnpjCpf: type: string description: CPF/CNPJ usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: skuFilial: description: Ligação do Sku/Filial type: object required: – empresa – filial – sku properties: id: type: string format: uuid description: Identificador Único empresa: type: object allOf: – #/definitions/empresa description: Empresa filial: type: object allOf: – #/definitions/filial description: Filial sku: type: object allOf: – #/definitions/sku description: SKU skuFilialFornecedores: type: array items: type: object allOf: – #/definitions/skuFilialFornecedor description: Ligação dos SKU/Filial/Fornecedor usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: skuFilialFornecedor: description: Ligação do Sku/Filial/Fornecedor type: object required: – empresa – skuFilial – fornecedor properties: id: type: string format: uuid description: Identificador Único empresa: type: object allOf: – #/definitions/empresa description: Empresa skuFilial: type: object allOf: – #/definitions/skuFilial description: Ligação do SKU/Filial fornecedor: type: object allOf: – #/definitions/fornecedor description: Fornecedor 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