O que você precisa
- Uma chave de API de empresa ou uma chave de organização. A receita só faz leituras, então a chave de organização funciona e traz as faturas de todas as empresas da organização de uma vez. Veja Chaves de API.
- O mês de referência das faturas, no formato
AAAA-MM.
Passo a passo
1
Liste as faturas do mês
Filtre as faturas pelo mês de referência com Só três situações seguem para o contas a pagar. As outras são faturas encerradas, que não devem ser pagas:
monthYear.Uma fatura em atraso continua
pending ou failed, com isLate: true.A lista traz faturas de todos os produtos da Salvy. Para só telecom, adicione product=telecom. Com uma chave de organização, cada fatura traz o companyId da empresa a que pertence.2
Detalhe cada fatura
O detalhe traz os itens cobrados e os dados da nota fiscal.O campo
nfe vem null enquanto a nota não foi emitida e quando ela foi cancelada. Nesses casos, pule a etapa 4 e avise o financeiro.3
Baixe o PDF da fatura
O PDF da fatura traz os dados de pagamento da cobrança vigente: boleto e Pix. Ele não é a nota fiscal.Trate a resposta 404 como “PDF indisponível” e siga para as próximas faturas, em vez de interromper o processo. No sandbox ela acontece sempre.
4
Baixe a NF-e em PDF e XML
Quando a fatura tem
nfe, baixe o DANFE em PDF e o XML da nota.Sem código: workflow do n8n
Se você usa o n8n, baixe o workflow pronto com as quatro etapas. Ele tem dois gatilhos: um manual, para testar, e uma agenda mensal, para rodar sozinho.Baixar workflow do n8n
invoice-nfe-accounts-payable.json: importe no n8n e siga as notas dentro do
workflow.- No n8n, crie um workflow e importe o arquivo (menu ⋯ > Import from File, ou cole o conteúdo do arquivo no editor).
- Crie uma credencial Bearer Auth com a sua chave de API e selecione-a nos cinco nós HTTP.
- Preencha o
mesReferenciano nó Dados de teste e execute. Se deixar vazio, vale o mês anterior. - Conecte o destino dos arquivos depois dos nós finais: e-mail do contas a pagar, SFTP, Google Drive ou o seu ERP.
- Para rodar todo mês, ative o workflow. As faturas são geradas no dia 1º de cada mês, e o nó Agenda mensal dispara no dia 5, às 8h, buscando o mês anterior. Os dias entre a geração e a agenda são uma margem para a fatura já estar disponível.
Como implementar
- Gatilho: uma rotina mensal. As faturas são geradas no dia 1º de cada mês; rodar no dia 5 dá margem para a fatura já estar disponível. Também dá para chamar o fluxo a partir do seu ERP.
- Destino dos arquivos: e-mail do contas a pagar, SFTP, uma pasta compartilhada ou a importação do seu ERP.
- Somente leitura: a receita não altera nada na Salvy, então pode ser executada quantas vezes for preciso.
Cuidados
Não pague faturas encerradas
Não pague faturas encerradas
Faturas com
status voided, refunded ou charged-back estão encerradas: não há nada a pagar. Filtre-as antes de enviar qualquer documento para o contas a pagar e registre-as à parte, como faz o workflow desta receita.O PDF da fatura não é a nota fiscal
O PDF da fatura não é a nota fiscal
GET /invoices/{id}/pdf traz o boleto e o Pix da cobrança vigente. A nota fiscal é o DANFE, em GET /invoices/{id}/nfe/pdf, com o XML em GET /invoices/{id}/nfe/xml. Envie os dois para o financeiro: um para pagar, outro para escriturar.Nota ainda não emitida ou cancelada
Nota ainda não emitida ou cancelada
Enquanto a NF-e não é emitida, e quando ela é cancelada, o campo
nfe da fatura vem null. Registre essas faturas para conferir depois, em vez de tratar a ausência da nota como erro.Chave de organização com muitas empresas
Chave de organização com muitas empresas
Com uma chave de organização, a lista traz as faturas de todas as empresas da organização. Use o
companyId de cada fatura para separar os documentos por empresa e percorra todas as páginas da lista, como no código acima.Variações
- Só telecom. Adicione
product=telecomna lista de faturas para ignorar as faturas de outros produtos da Salvy. - Cobrar o que está em atraso. Filtre por
isLate: truepara montar um alerta de faturas vencidas e ainda abertas. - Rateio por centro de custo. Para lançar o custo de telecom por centro de custo, use o detalhamento por linha da fatura em
GET /api/v3/invoices/{id}/phone-accounts.