As Categorias no Omie desempenham um papel fundamental na organização das receitas e despesas de uma empresa, facilitando a gestão e visualização de relatórios financeiros, como o DRE e o Fluxo de Caixa.
Este artigo explora como cadastrar e alterar Categorias por meio da API do Omie.
Antes que possa começar de fato os testes com a nossa API, é importante conhecer alguns processos básicos:
💡 #DicaDoBem: Atualmente, conseguimos testar as nossas API’s diretamente pelo site do Developer, porém, existem alguns programas que também podem realizar esse processo, como o Postman, Insomnia e o ThunderClient (uma extensão do VS Code). |
Para o nosso teste, vamos utilizar diretamente o Developer. Assim como, vamos utilizar o APP KEY e o APP SECRET padrões, mas se preferir, pode alterar para o seu 😉
Tópicos do artigo:
Cadastrando a Categoria
Para cadastrar uma Categoria, vamos criar uma requisição através do método "IncluirCategoria". Este método, pode ser acessado por aqui:
Ao acessar, clique em “Teste agora mesmo”. Será aberta uma nova aba em seu navegador para poder utilizar o Developer:
Na requisição, é preciso informar alguns parâmetros obrigatórios, assim como no cadastro de categorias em tela. São eles:
"categoria_superior": este parâmetro, refere-se ao grupo da categoria;
"descrição": você informará neste parâmetro o nome da categoria que deseja cadastrar.
📌 Lembrete
Você pode obter o código da Categoria Superior que deseja informar, através do método "ListarCategorias":
As categorias superiores/agrupadoras, no retorno da requisição, tem o código com no máximo 4 dígitos, neste formato: “X.XX”
Veja esta requisição de exemplo:
{
"categoria_superior": "1.01",
"descricao": "Venda de mercadoria em consignação",
"natureza": "Utilize apenas para venda de produtos consignados"
}
Observe que usei outros parâmetros que não estão na requisição de exemplo, mas que podem ser consultados por aqui:
Após informar o "OMIE_APP_KEY" (1), "OMIE_APP_SECRET (2)" e a requisição (3), basta clicar em "Executar" (4):
Veja que na mensagem retornada, o sistema Omie confirma a inclusão da categoria.
Essa tag retornada “codigo” é muito importante, pois, é com ela que vamos consultar e fazer operações com nossa Categoria via API.
No sistema Omie, será possível visualizar a Categoria cadastrada:
Alterando uma Categoria
Para alterar uma Categoria, vamos criar uma requisição através do método "AlterarCategoria". Este método, pode ser acessado por esse link abaixo:
Ao acessar o método, clique em “Teste agora mesmo”. Será aberta uma nova aba em seu navegador para poder utilizar o Developer.
Para iniciarmos, precisamos dizer para o sistema qual a categoria que desejamos alterar. Isso será feito pelo parâmetro “codigo”.
É possível alterar várias informações na categoria. Neste exemplo que preparamos, vamos vincular a categoria a um grupo do DRE.
📌 Lembrete
Você pode listar as categorias que tem cadastradas no sistema para identificar o código atrelado a categoria pelo método ListarCategorias:
Para obter o código da conta do DRE, utilize este outro método:
Veja esta requisição de exemplo:
{
"codigo": "1.01.95",
"codigo_dre": "1.01.01"
}
Outros parâmetros que não estão no exemplo, podem ser consultados por aqui:
Após informar o "OMIE_APP_KEY" (1), "OMIE_APP_SECRET" (2) e a requisição (3), basta clicar em "Executar" (4):
Observe que ele nos retornou a mensagem confirmando a alteração na categoria:
No sistema Omie, será possível visualizar a alteração realizada na Categoria:
💡 Dica: Em alguns parâmetros, ao passar o mouse sobre o "+", exibiremos uma descrição sobre como utilizar essa opção:
📚 Artigos Relacionados
