Sabemos que cada negociação é única — seja na hora de vender ou comprar, é comum alinhar condições específicas de parcelamento com seus clientes ou fornecedores.
Pensando nisso, o Omie traz uma funcionalidade que é a cara da flexibilidade: você pode criar suas próprias opções de parcelamento, além das que já vêm prontas no sistema! 🚀💙
⚠️ Importante
Cadastre uma única vez por aplicativo: um novo Número de Parcela só precisa ser cadastrado uma vez no ERP. Então, ele estará disponível em todos os módulos do Omie com esse recurso.
Número de Parcelas por aplicativo: cada aplicativo Omie possui sua própria tabela de parcelas, então, o seu cadastro é individual por aplicativo.
Informações Importantes sobre as APIs Omie
Antes de iniciar seus testes com a nossa API, é fundamental conhecer alguns processos básicos:
✅ Acessando a documentação: consulte nossa documentação oficial para entender os endpoints disponíveis e seus respectivos parâmetros;
🔑 Chaves de Integração da API: saiba como obter e utilizar suas credenciais de acesso para autenticar as requisições;
⚙️ Características e Recomendações: fique por dentro das melhores práticas para otimizar sua experiência com a API da Omie;
🔐 Login no Portal: para testar suas requisições no Portal do Desenvolvedor é necessário fazer login na plataforma com o mesmo e-mail e senha que você já usa no ERP. Fácil, né? 😉
🧪 Aplicativo Teste: aprenda a criar um Aplicativo Teste gratuito e descubra, na prática, como utilizar nossas APIs e aproveitar ao máximo os nossos recursos.
💡 Dica
Você pode testar nossas APIs diretamente no nosso Portal do Desenvolvedor. Além disso, ferramentas como Postman, Insomnia e ThunderClient (extensão do VS Code) também são ótimas opções para realizar testes.
Cadastrando um novo Número de Parcelas via API
1) No Portal do Desenvolvedor, acesse a lista de APIs:
2) No tópico "Geral", selecione a opção Parcelas:
3) Para incluir um novo Número de Parcela, é preciso utilizar o método IncluirParcela:
4) Após selecionar o método IncluirParcela, você poderá os parâmetros disponíveis (1).
Para realizar um teste rápido com os parâmetros básicos, basta clicar em "Teste agora mesmo" (2):
5) Para realizar um teste pelo Developer - Portal do Desenvolvedor, é preciso realizar o login no Omie:
6) Após realizar o login, você será direcionado para a tela de testes do Developer, onde poderá configurar e enviar requisições para a API. Veja como cada campo funciona:
(1) Endpoint: o Omie preencherá automaticamente este campo com:
🔗 https://app.omie.com.br/api/v1/geral/parcelas/
(2) Aplicativo ou Chave de Acesso: aqui, você verá uma lista dos aplicativos aos quais seu e-mail tem acesso. Basta selecionar o desejado, e os campos App Key e App Secret serão preenchidos automaticamente;
📣 Lembrete
Caso precise testar um aplicativo que não aparece na lista, selecione "O aplicativo que eu quero não está na lista" e insira manualmente suas credenciais.
(3) Call: o Omie definirá automaticamente o tipo de chamada como IncluirParcela;
(4) Conteúdo: este é o campo onde você configurará sua requisição, inserindo os dados necessários para incluir seu Número de Parcela.
7) A seguir, demonstramos um exemplo de requisição para a inclusão de um novo Número de Parcela:
{
"cParcela": "22/33/45"
}
📣 Lembrete
Atualmente, ao cadastrar um Número de Parcelas, há quatro tipos de formatações aceitas. Você pode seguir os seguintes exemplos:
10/20/30/40. Com este tipo de formatação, o sistema entenderá que deve cadastrar 4 Parcelas. Sendo a primeira para 10 dias, a segunda para 20 dias e, assim, sucessivamente.
A Vista/40/60. Nesta formatação, será cadastrada para 3 Parcelas. Sendo a primeira a vista, a segunda para 40 dias e, a terceira, para 60 dias.
Para 93 dias. Com esse preenchimento, será cadastrada uma Parcela para 93 dias após o faturamento.
50. Ao indicar um número único, o sistema entenderá que se trata da quantidade total de Parcelas. Neste caso, será cadastrado 50 Parcelas.
8) Ao executar a requisição com todos os parâmetros corretamente informados, você receberá uma resposta positiva contendo o código do Número de Parcela.
Esse identificador, retornado na tag “cCodParcela”, é fundamental, por servir como referência para a realização de operações via API:
9) Tudo pronto! No Omie ERP, o Número de Parcela estará cadastrado para todos os módulos:
