Fluxo - Recebimento Fatura
O fluxo demonstrado a seguir trata do recebimento de Fatura dentro da integração com a InvoiSys.
APIs Essenciais 💡
Realizar consulta Fatura por NSUi: /v1/fatura-entrada/eventos-nsui/{cnpj}/{nsui}
Realizar Envio XML de Fatura: v1/fatura-entrada/enviar-xml
Indicar Cancelamento de Fatura: v1/fatura-entrada/indicar-cancelamento/{ambiente}/{id}
APIs Opcionais 🥈
Realizar consulta de XML de Fatura: v1/fatura-entrada/obter-xml/{ambiente}/{id}
Realizar envio de Anexo: v1/fatura-entrada/anexar
Realizar consulta de anexo de Fatura: /v1/fatura-entrada/obter-anexo/{ambiente}/{id}
Etapas e suas APIs
Antes de iniciamos a consulta das notas, é necessário estar com um token de acesso válido, pois este será utilizado no cabeçalho da chamada das APIs. Tendo ele em mãos, podemos partir para as devidas operações do fluxo.
1) Consultar Fatura por NSUI
Com as Faturas disponibilizadas em nossa solução, temos duas funcionalidades disponiveis para a obtenção das informações capturadas das Faturas:
a) Consulta de Fatura através do NSUI b) Consulta de Fatura por ID
a) Consulta da Fatura por NSUI
Este e o processo de consulta dos documentos utilizando o Número Sequencial Único Invoisys (NSUi), que são vinculados aos Documentos e o CNPJ do Contratante.
Cada Consulta Retorna até 50 documentos de acordo com o Numero Sequencial, informando também o ultimo numero consultado e o numero sequencial máximo disponível para consulta.
b) Consulta de Fatura por ID
Está API é utilizada para efetuar a consulta do XML no formato base64 de uma Fatura de Entrada, pelo ID do documento, retornado no momento da carga do documento ou nos detalhes da Fatura.
2) Indicar cancelamento de Fatura
Usado para atribuir o status de cancelamento para uma Fatura por um ID de Documento.
3) Enviar Anexo
Através desse endpoint é possível enviar um arquivo (imagem, pdf, texto, etc) e vincula-lo a um documento através de seu ID informado no momento de sua carga ou de sua consulta via NSUI.
4) Consultar Anexo
Através desse endpoint é possível obter o arquivo (imagem, pdf, texto, etc) enviado através do enpoint de Envio de Anexo em base64, utilizando o ID do Arquivo devolvido no momento da carga do anexo.
Last updated
Was this helpful?