Sign in

v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
bills

Antecipa imediatamente a cobrança de uma fatura através do ID.

Utilize este método para antecipar imediatamente a cobrança de uma fatura agendada (status=scheduled) ou então para cobrar um saldo devedor. Uma nova cobrança será emitida automaticamente.

post/v1/bills/{id}/charge

Path parameters

idinteger required

ID da fatura que será antecipada.

Request body

bodystring

JSON opcional com os atributos da fatura.

payment_method_codestring

Código do método de pagamento. Se não informado, o método atual será utilizado

installmentsinteger

Número de parcelas. Se não informado, o valor atual será utilizado

Response

Fatura antecipada com sucesso.

idinteger required

ID da fatura

codestring

Código externo para referência via API

amountnumber required

Valor da fatura

installmentsinteger required

Número de parcelas

status'review' | 'pending' | 'paid' | 'canceled' | 'scheduled' required

Status da fatura

seen_atstring required

Última visualização da fatura

billing_atstring

Data opcional de emissão da cobrança

due_atstring

Data de vencimento da fatura

urlstring required

URL para pagamento da fatura

created_atstring required

Data e hora da geração da fatura

updated_atstring required

Data e hora da última atualização da fatura

metadataobject

Metadados da fatura