Cria uma nova fatura avulsa.

POST https://app.vindi.com.br/api/v1/bills

Faturas avulsas são independentes de assinaturas e podem ser usadas para cobrar qualquer tipo de valor não recorrente.

Todas as faturas seguirão as configurações de retentativa e notificações previamente configuradas na plataforma.

Exemplo

A maioria dos parâmetros deste método são opcionais. O exemplo abaixo efetua a emissão de uma fatura avulsa usando apenas os atributos obrigatórios:

{
  "customer_id": 28,
  "payment_method_code": "bank_slip",
  "bill_items": [
    {
      "product_id": 14,
      "amount": 100
    }
  ]
}

Recomendamos que você implemente apenas estes parâmetros obrigatórios e adicione os opcionais a medida que a necessidade sugir. Normalmente o comportamento padrão da plataforma é suficiente para a maioria dos casos de uso.

Lista de produtos

Sua fatura avulsa deve conter no mínimo um item na lista bill_items. Você deve referenciar o produto através do parâmetro product_id ou product_code.

Diferente das faturas geradas a partir de assinaturas, o valor dos itens das faturas avulsas pode ser informado através do parâmetro amount dentro da lista bill_items.

Apesar do bill_item suportar um esquema de precificação (pricing_schema) com quantidade (quantity), recomendamos utilizar apenas o parâmetro amount para evitar complexidade desnecessária no desenvolvimento. Se pricing_schema, quantity e amount forem informados ao mesmo tempo, garanta que todos sejam mutuamente válidos.

Método de pagamento

É obrigatório informar o código do método de pagamento para a geração da fatura. Caso o método escolhido seja cartão de crédito, por exemplo, a plataforma irá tentar efetuar a cobrança com o cartão já cadastrado para o respectivo cliente. Caso nenhum cartão esteja cadastrado, a plataforma enviará por padrão um e-mail automático solicitando os dados de pagamento.

Se preferir, você ainda poderá efetuar a captura dos dados de pagamento de duas outras formas diferentes:

• Capture os dados em uma página própria (obrigatoriamente com HTTPS) e informe-os para a Vindi através do método da API POST payment_profiles antes de criar a fatura;
• Ou então redirecione o cliente para o parâmetro url da fatura recém-criada, onde ele poderá imprimir o boleto ou inserir as informações de pagamento dentro do ambiente seguro da Vindi.

Condição de pagamento

Por padrão, a condição de pagamento configurada no método de pagamento será utilizada para emitir a cobrança da fatura avulsa.

Se desejar customizar a condição para uma fatura específica, informe o parâmetro payment_condition.

Caso você receba um erro no atributo payment_condition informando que o mesmo é inválido, verifique se os dados de data de vencimento due_at, data de agendamento billing_at e desconto por pontualidade payment_condition.payment_condition_discounts.days_before_due estão válidos. O valor da data do limite de desconto não pode ser retroativa, sendo assim, é possível que o parâmetro payment_condition fique inválido mesmo que não tenha sido informado, visto que as informações do método de pagamento escolhido serão utilizadas por padrão.