Introdução

  • Uma fatura pode conter um ou mais itens;
  • Cada item é um valor direcionado para o pagamento de uma parcela;
  • Os itens podem ser com o valor total da parcela, um valor parcial ou um valor com desconto;
  • O responsável pelo pagamento da fatura pode ser uma empresa ou um cliente;
  • A fatura é emitida por beneficiário do pagamento. Se você opera com múltiplos fundos, pode ser necessário gerar diferentes faturas por mês para cada empresa.

Criar faturas automaticamente

É possível configurar a criação de faturas automaticamente. A configuração pode ser feita para faturas recorrentes da empresa e do cliente.

Data da geração

A fatura será gerada considerando os dias de antecedência para o vencimento. De acordo com o exemplo abaixo, a fatura será criada 10 dias antes da data de vencimento da parcela (installment.dueDate).

{
  "customerRecurring": {
    "daysUntilDue": {
      "type": "absolute",
      "amount": 10
    },
    "create": {
      "cutoffDay": 1,
      "autoCreate": true
    }
  }
}    

A data de geração da fatura também pode ser fixa no mês. No exemplo abaixo, todas as faturas serão geradas no dia 5 de cada mês. Nesse caso, se a data de vencimento da parcela for dia 25, o pagador receberá a fatura com 20 dias de antecedência.

{
  "customerRecurring": {
    "daysUntilDue": {
      "type": "static",
      "amount": 5,
    },
    "create": {
      "cutoffDay": 1,
      "autoCreate": true
    }
  }
}      

Fatura recorrente do cliente

As faturas para as parcelas que já estão com vinculadas a um cliente (installment.payer = "cust_...") serão criadas automaticamente se customerRecurring.create.autoCreate = true.

Fatura recorrente da empresa

As faturas para as parcelas que estão vinculadas a uma empresa (installment.payer = "comp_...") serão geradas automaticamente se companyRecurring.create.autoCreate = true.

Alterar o pagador

As faturas recorrentes da empresa podem ser geradas cobrando a empresa ou o cliente. Gerar a fatura da empresa cobrando o cliente pode ser útil para os cenários em que o cliente não tem margem consignável disponível e precisa fazer o pagamento do valor restante. Configurar a geração da fatura para a empresa é usado somente considerando que a empresa esqueceu de informar algum desconto.

Se companyRecurring.create.payer = "customer", as parcelas da empresa que não estão em uma fatura serão adicionadas individualmente em faturas e cobradas do cliente (payer = "cust_").

Configuração:

{
  "companyRecurring": {
    "create": {
      "cutoffDay": 25,
      "autoCreate": true,
      "payer": "customer"
    }
  }
}

Parcelas:

ClienteValor da parcela
Sofia Silva200
Lucas Santos650
Isabella Costa1420

Faturas geradas:

Fatura da empresa gerada manualmente pelo RH no dia 18

ClienteValor descontado
Sofia Silva200
Lucas Santos600
Isabella Costa0

Fatura do Lucas Santos gerada automaticamente no dia 26

ClienteValor descontado
Lucas Santos50

Fatura da Isabella Costa gerada automaticamente no dia 26

ClienteValor descontado
Isabella Costa1420

No exemplo acima, a parcela do Lucas e da Isabella foram geradas automaticamente para garantir o pagamento total das parcelas. A fatura do Lucas cobra apenas um valor parcial de R$ 50. O restante foi descontado da folha de pagamento. A fatura da Isabella cobra o valor total, já que nenhum valor foi descontado pelo RH.

Criar faturas manualmente

  1. Consulte todas as parcelas com valor pendente de pagamento que vencem no mês atual /v1/installments?due_date_start=2022-11-01&due_date_end=2022-11-31;
  2. Agrupe as parcelas pelo payer + fund;
  3. Crie uma fatura. Por padrão, o status será draft;
  4. Crie um item de fatura para cada parcela. Você pode considerar o valor total ou valor parcial e também incluir um desconto;
  5. Quando inserir todos os itens, você pode finalizar a fatura /v1/invoices/{invoice}/finalize;
  6. Para gerar um boleto, é necessário criar uma intenção de pagamento. Uma fatura pode ter múltiplas intenções de pagamento. /v1/invoices/{invoice}/payment-intents

Cenário de exemplo 01:

  1. Existe um total de 10.000 parcelas com vencimento em novembro.
  2. Serão criadas 500 faturas para empresas e 700 faturas para clientes que foram desconsignados.
  3. Total de 1.200 faturas para fevereiro.

Pagamento parcial

O pagamento parcial é utilizado quando um funcionário não tem a margem consignável total disponível ou é demitido e a empresa consegue realizar o pagamento usando a verba rescisória. Nesse caso, pode resultar em um valor que não é suficiente para cobrar uma parcela completa.

Exemplo:

  1. O valor da parcela do empréstimo é R$ 200 e ainda existem 24 parcelas pendentes.
  2. É possível direcionar R$ 500 da verba rescisória para o pagamento do empréstimo.
  3. Será possível gerar uma fatura com 2 parcelas completas e uma 3ª parcela com um valor menor.
  4. Quando a fatura é paga, o valor parcial fica disponível para consultado no campo installment.transactions e o valor devido é atualizado no campo installment.amountRemaining

Pagamento com desconto

Se o cliente decidir fazer um pagamento antecipado, você deve adicionar a diferença como um desconto.

Exemplo:

  1. O valor da parcela é R$ 500 com vencimento no próximo ano.
  2. Após calcular o valor presente, o valor será de R$ 350.
  3. Adicione um item com amount: 500 e discount: 150.
  4. Quando a fatura por paga, a parcela será considerada completamente quitada.

É importante notar que as etapas específicas e os detalhes do fluxo podem variar dependendo da implementação. Além disso, algumas APIs podem oferecer recursos adicionais, como pagamento integrado ou geração automática de faturas.