installment
string
required

Identificador que faz referência a uma parcela.

amount
number
required

Valor da parcela que será considerado como pago. Pode ser menor (para realizar pagamento parcial da parcela) ou igual ao valor original da parcela.

discount
number

Valor do desconto que será dado na fatura referente a parcela informada

fine
number

Valor da multa

interest
number

Valor do juros

description
string

Descrição do item.

purposeKey
string

Chave de propósito do item da fatura.

updateInvoiceItemOnInsert
boolean

Sobrescrever configuração de desconto e multa no momento da criação dos itens da fatura. Este campo determina se, no momento da criação dos itens da fatura, descontos ou multas serão aplicados automaticamente aos itens de fatura enviados na requisição. Quando este campo é informado, o valor nele especificado substituirá o valor contido em settings.invoices[type].updateInvoiceItemOnInsert. É importante destacar que essa configuração apenas se aplica à requisição atual e não afetará as configurações existentes. Esse recurso foi desenvolvido com o propósito de substituir o parâmetro settings.invoices[type].updateInvoiceItemOnInsert pelo valor enviado na requisição.

deductFineInterestFromAmount
boolean

Quando definido como verdadeiro (true), caso a parcela esteja atrasada e o valor (amount) fornecido seja menor do que o valor restante (amountRemaining), os valores de multa (fine) e juros (interest) do item serão recalculados proporcionalmente ao valor pago (amount) e, então, deduzidos do valor do item, substituindo os três respectivos campos fornecidos na requisição pelos valores proporcionais calculados.

metadata
object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.