De modo geral, o crédito consignado funciona da seguinte forma: os funcionários fazem um empréstimo e assumem o pagamento do mesmo através de parcelas. O RH é o responsável por reter o valor das parcelas mensalmente, valor este que é deduzido do salário do funcionário. O valor retido pelo RH é então repassado para a financeira através do pagamento da fatura recorrente da empresa.

​
Pré requisitos

Antes de criar uma fatura recorrente, é necessário já ter realizado as seguintes configurações:

​
Fatura recorrente

A fatura recorrente é aquela que agrupa as parcelas dos empréstimos contratados pelos funcionários e que devem ser pagas em um determinado mês. O RH é responsável por gerenciar quais parcelas serão descontadas dos funcionários e poderão ser incluídas na fatura.

​
Exceções

Por lei, o valor das parcelas a serem descontadas precisam estar dentro da margem consignável disponível, que atualmente é de 35% sobre o valor do salário líquido. Como o valor do salário líquido pode variar mensalmente devido a diversos fatores, cabe ao RH realizar a análise de cada funcionário antes que o desconto seja realizado. Confira abaixo os casos mais comuns que podem afetar o valor do salário líquido:
  • Afastamento médico
  • Férias
  • Desconto por faltas
  • Demissão

​
Quando a fatura deve ser criada

Toda parcela em aberto precisa ser paga. No fluxo padrão, que é quando o funcionário está com vínculo empregatício ativo e tem margem disponível, a parcela deve ser incluída integralmente na fatura recorrente do mês vigente referente ao vencimento da parcela. Caso a parcela não puder ser descontada pelo RH, ela não deverá ser incluída na fatura recorrente da empresa e o sistema irá gerar uma fatura específica para cobrar diretamente o funcionário. Caso o valor da parcela seja descontado parcialmente, o valor descontado deve ser incluído na fatura recorrente da empresa e a diferença será cobrada em uma nova fatura específica criada automaticamente pelo sistema, colocando o funcionário como responsável pelo pagamento. A fatura recorrente da empresa deve ser criada até o limite da data de corte configurada no sistema.
Se a empresa não tiver incluído nenhuma parcela em nenhuma fatura, o sistema criará automaticamente uma fatura com todas as parcelas quando a data de corte fechar. Caso a empresa tenha criado algumas parcelas (mas não todas) em uma fatura, o sistema irá gerar uma fatura diretamente para o funcionário, cobrando as parcelas que não foram incluídas..

​
Como criar a fatura recorrente da empresa

Uma vez definido o valor e as parcelas foram descontadas em folha, esse valor precisa ser informado através de uma fatura, para que assim ocorra a cobrança da empresa.

​
Via API

Para a criação da fatura recorrente via API utilize o endpoint: Criar fatura
  • No parâmetro type (que é responsável por definir o tipo de fatura), selecione a opção company_recurring para informar ao sistema que se trata de uma fatura recorrente da empresa.
Quando todas as parcelas e valores que devem ser incluídos já estiverem definidos no momento da criação da fatura, é possível informá-los na mesma requisição da criação. Para isso basta preencher o parâmetro items. Conforme a documentação, items é uma lista de parcelas que no contexto de criação de fatura, chamamos de itens de fatura. Se todos os itens de fatura já tiverem incluídos e não houver necessidade de nenhuma alteração, a fatura pode ser criada e finalizada na mesma requisição, basta preencher o parâmetro autoFinalize com o valor true. 
curl --request POST \
  --url https://api.base39.io/v1/invoices \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "company_recurring",
  "items": [
    {}
  ],
  "autoFinalize": true
}'
Se por algum motivo nem todos os itens estiverem confirmados e houver necessidade de alterações na fatura, é possível criar uma fatura como rascunho, isso permitirá que os itens possam ser alterados e/ou removidos do rascunho. Para isso, basta preencher o parâmetro autoFinalize com o valor false.

​
Itens da fatura

Itens de fatura nada mais são do que as parcelas de um empréstimo e agrupamento dessas parcelas formam a fatura. Enquanto a fatura ainda não estiver finalizada, ela pode ser atualizada e novos itens podem ser adicionados ou removidos. Confira abaixo como listar, adicionar e remover itens de fatura:

​
Finalizar uma fatura

Para que uma fatura possa ser paga, ela necessita ser finalizada. Confira abaixo as configurações necessárias para finalizar uma fatura:

​
Intenção de pagamento

Para realizar o pagamento da fatura, é necessário vinculá-la a uma intenção de pagamento. A intenção de pagamento define como o pagamento deve ser realizado. No caso das faturas recorrentes da empresa, o meio de pagamento mais utilizado é o boleto bancário. Logo, a intenção de pagamento nada mais é do que a configuração do boleto. Crie uma intenção de pagamento via API utilizando endpoint: Quando uma intenção de pagamento do tipo boleto é criada via API, a plataforma realiza a integração com o provedor para efetuar a geração automática do boleto, que ficará disponível quando a fatura for consultada.