Integração com o seu software
O que fica com o seu sistema e o que fica com o gateway, os dados de cada nota, o retorno e como começar.
- Divisão de papéis entre o seu sistema e o gateway
- Dados que o seu sistema informa
- O que volta para o seu sistema
- Situações que a sua tela precisa mostrar
- Como começar a integração
O que fica com cada lado
A integração separa o que é do seu produto do que é fiscal:
| Seu sistema | Gateway de NFS-e |
|---|---|
| A tela de emissão e a experiência do seu cliente. | A conferência dos dados contra as regras do município. |
| Os cadastros do negócio: clientes, serviços e valores. | O envio à prefeitura no padrão do município do prestador. |
| O momento de emitir: quando o seu cliente pede ou quando a sua regra de negócio manda. | O acompanhamento da resposta e o registro de cada etapa. |
| A exibição da nota pronta para o seu cliente. | A atualização contínua das regras fiscais, dos layouts e das exigências técnicas de cada município. |
Com essa divisão, o seu time não precisa manter um módulo fiscal interno nem acompanhar as mudanças de cada prefeitura.
Dados que o seu sistema informa
Cada pedido de emissão leva os dados da nota de serviço:
- Prestador: a empresa emissora, com o CNPJ e o município, já configurada para emitir (ver Configuração da emissão).
- Tomador: o documento de quem contratou o serviço.
- Serviço: a descrição e o código de serviço do município.
- Valores: o valor total do serviço, que precisa ser maior que zero, e a alíquota do ISS.
Esses são os mesmos pontos que o gateway confere antes do envio. Quanto mais confiável for o cadastro no seu sistema, menos notas voltam rejeitadas. O detalhe de cada campo está no assunto Emitir uma nota.
O que volta para o seu sistema
Com a nota autorizada, o seu sistema recebe:
- o número oficial da NFS-e e a data de autorização;
- o código de verificação gerado pela prefeitura;
- o PDF da nota, para o seu cliente baixar ou enviar ao tomador;
- o XML autorizado, que é a nota fiscal em si e deve ser guardado.
Com a nota rejeitada, o retorno traz o motivo com o código e a mensagem da prefeitura, para a sua tela mostrar ao usuário o que corrigir.
Situações que a sua tela precisa mostrar
Uma nota passa por situações diferentes, e cada uma pede uma reação diferente na sua tela:
- Processando: a nota foi enviada e aguarda a prefeitura. Mostre que a emissão está em andamento.
- Autorizada: ofereça o PDF e o XML e mostre o número e o código de verificação.
- Rejeitada: mostre o motivo e permita corrigir os dados e emitir de novo.
- Cancelada: a nota deixou de valer depois de autorizada.
- Substituída: a nota foi trocada por outra, que passa a valer no lugar dela.
O significado de cada situação e as regras de cancelamento estão no assunto Situações da nota e cancelamento.
Como começar
- Fale com o time da JR pela página de contato do site e conte o seu cenário: o tipo de sistema, os municípios dos seus clientes e como você quer vender a emissão.
- Receba o plano de integração, alinhado ao seu cenário técnico e comercial.
- Escolha o modelo comercial: pacotes mensais de emissão, emissão incluída nos planos avançados ou cobrança pelo volume real emitido.
- Integre e ative a emissão para os seus clientes e expanda para mais municípios sem sobrecarregar o seu time técnico.
As especificações técnicas da integração ainda não estão publicadas nesta documentação. Até lá, o caminho técnico é tratado com o time da JR no plano de integração.