Criar fatura avulsa
Cria uma fatura separada do ciclo, com vencimento e formas de pagamento próprios.
POST /invoices
Faz parte do recurso Faturas — o conceito, os oito estados e os
links hospedados estão lá.
Cria uma cobrança fora do ciclo, atrelada a uma assinatura: uma taxa de implantação, um acordo de
dívida, um serviço pontual. O cliente recebe uma cobrança própria, com vencimento e formas de
pagamento independentes da mensalidade. Para valores pequenos que podem esperar a virada do ciclo,
prefira lançar uma cobrança extra — ela entra na fatura da
mensalidade, sem gerar uma segunda cobrança.
dueAt precisa ser futuro; a cobrança é
disparada em dueAt - chargeLeadTimeDays da assinatura. Com folga, a fatura nasce scheduled
e vira open na hora certa; vencimento próximo nasce open e cobra já. Se a data cair em fim
de semana ou feriado e a conta só cobra em dia útil, o vencimento desliza para o próximo dia útil.Authorizations
API Key da Credential (gerada no Backoffice)
Headers
Chave única para garantir idempotência da requisição
Body
Assinatura dona da fatura. Aceita contratos encerrados — é o caminho para cobrar um valor renegociado ou dívida remanescente.
1O que está sendo cobrado (aparece na linha da fatura e na página de pagamento).
1 - 200Valor unitário, em centavos (menor unidade da moeda). A moeda é a da assinatura.
x > 0Vencimento (ISO 8601 com timezone), estritamente no futuro. A cobrança dispara em dueAt - chargeLeadTimeDays da assinatura; se a data cair em fim de semana ou feriado e a política da conta só cobrar em dia útil, o vencimento desliza para o próximo dia útil.
Classificação da cobrança, para auditoria e relatório.
extra_service, adjustment, penalty, ad_hoc, other Justificativa em texto livre (1 a 500 caracteres). Fica na trilha de auditoria — o pagador não vê; o que ele vê é description.
1 - 500Quantidade. Default 1 — o total da fatura é amount * quantity.
x > 0Formas de pagamento oferecidas na página de pagamento desta fatura. Ausente = o método padrão da assinatura.
1 - 3 elementscard, pix, boleto Parcelamento oferecido ao pagador no cartão — só faz sentido com card em allowedPaymentMethods. Ausente/null = à vista.
Response
Fatura criada