Passar para o conteúdo principal
Todas as coleçõesAPIs e WebhooksExemplos de API
Faturando Contratos de Serviço em Lote via API
Faturando Contratos de Serviço em Lote via API

Neste artigo, descubra como faturar diversos Contratos de Serviço de uma vez, via API.

Thais Oldani avatar
Escrito por Thais Oldani
Atualizado há mais de 2 meses

As APIs do Omie foram desenvolvidas para oferecer flexibilidade e eficiência na integração de sistemas e automatização de processos, permitindo que você conecte suas soluções diretamente ao Omie.

Aqui, vamos explicar como o faturamento em lote opera e os detalhes preliminares necessários antes de executá-lo.

Preparado para simplificar sua gestão e otimizar seu tempo? Então, vamos lá! 🚀

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.

  • ⚙️ 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 nosso recursos.

💡 Dica Omie: 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.

Entendendo o Faturamento em Lote via API


​1) No Omie, é possível registrar seus Contratos de Prestação de Serviço.

Durante o cadastro, é necessário fornecer a data de início da vigência (dVigInicial), a data de término da vigência (dVigFinal) e o dia específico para faturamento do contrato (nDiaFat).

Essas datas delimitam o período em que o contrato estará ativo e definem o momento em que os serviços serão faturados, simplificando a sua gestão de contratos e a execução dos serviços dentro do prazo acordado.

💡 Se você precisar modificar informações do Contrato de Serviço, utilize o método "AlterarContrato".

2) Então, considerando a vigência e o dia de faturamento definidos em cada contrato, o sistema identifica exatamente quais contratos devem ser faturados no dia atual.

Todos os Contratos de Serviço com faturamento para hoje serão automaticamente transferidos para a coluna "Faturar Hoje" no Kanban de Contratos:

Realizando o Faturamento em Lote via API

1) Para realizar o faturamento em lote, basta utilizar o método FaturarLoteContrato, todos os contratos listados na coluna "Faturar Hoje" serão faturados de uma vez:

{
  "cCodIntLote": "9999999"
}

2) Ao receber a resposta da requisição, você terá acesso ao Código do Status do Processamento (cCodStatus):
​

📌 cCodStatus

  • Se o retorno for '0' significa que a solicitação foi executada com sucesso.
    ​

  • Se o retorno for maior que '0' ocorreu algum erro durante o processamento da solicitação.

3) Para obter detalhes adicionais sobre o faturamento e verificar se as notas foram emitidas, utilize o método "ListarLotesContrato", com a tag "cExibirDetalhes", conforme ilustrado no exemplo abaixo:
​

{
  "dDtIncDe": "28/11/2023",
  "dDtIncAte": "29/11/2023",
  "cExibirDetalhes": "S"
}

4) Assim, será fornecido o status da emissão, que pode ser: RUNNING, DONE ou ERROR:


​5) Se houver algum erro no cStatus, detalhes adicionais serão exibidos na tag cMensagem:


Nessa situação, após fazer as correções necessárias, basta faturar o lote novamente.

📚 Artigos Relacionados

Respondeu à sua pergunta?