InvoiceItemCreate

Criar um item de fatura

installmentstringrequired

Identificador que faz referência a uma parcela.

Example: inst_631a1f531a40784a5b1df6ed

amountdoublerequired

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

discountdouble

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

finedouble

Valor da multa

interestdouble

Valor do juros

descriptionstring

Descrição do item.

purposeKeystring

Chave de propósito do item da fatura.

updateInvoiceItemOnInsertboolean

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.

Example: true

deductFineInterestFromAmountboolean

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.

Example: true

metadataobject

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.

InvoiceItemCreate

{
  "installment": "inst_631a1f531a40784a5b1df6ed",
  "amount": 0,
  "discount": 0,
  "fine": 0,
  "interest": 0,
  "description": "string",
  "purposeKey": "string",
  "updateInvoiceItemOnInsert": true,
  "deductFineInterestFromAmount": true,
  "metadata": {}
}