VIvindi
bills

Atualiza uma fatura existente.

Utilize este método para alterar os atributos de uma fatura existente.

Reagendamento da cobrança agendada

Através do atributo billing_at é possível atualizar a data da cobrança uma fatura agendada (status=scheduled) para qualquer outra data no futuro. Esteja ciente que este método não permite o reagendamento para hoje. Se desejar antecipar imediatamente a cobrança uma fatura agendada, utilize o método POST /bills/{id}/charge.

put/v1/bills/{id}

Request

  • Base URL
    //app.vindi.com.br/api (relative, and the document’s source URL is not known)
  • URL
    //app.vindi.com.br/api/v1/bills/{id}
  • Auth
    HTTP basic

Path parameters

idinteger required

ID da fatura que deverá ser atualizada.

Request body

bodystring

JSON com os novos atributos da fatura.

codestring

Código externo para referência via API

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

billing_atstring

Data opcional de emissão da cobrança no formato ISO 8601. Apenas para faturas agendadas

due_atstring

Data opcional de vencimento da cobrança no formato ISO 8601. Apenas para faturas agendadas

metadata'array'

Metadados da fatura

Response

Fatura atualizada 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

Changes

No recorded changes to this operation across all 1 revision of this API.