Antes que você possa começar de fato os testes com a nossa API, é importante conhecer alguns processos básicos:

💡 Dica para melhorar a sua experiência

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 as suas credenciais. 😉

Entendendo o Faturamento em Lote via API

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

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 só.

{
  "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.