InvoiceCreate
Responsável pelo pagamento. Pode ser um customer
ou company
.
Fundo que vai receber o pagamento.
A data de vencimento da fatura.
Tipo da fatura
pay_off
, customer_recurring
, company_recurring
Propósito da fatura
cancellation
, customer_refinance
, employment_terminated
, external_collector
, no_funds
, regular
, requested_by_company
, requested_by_customer
, requested_by_insurance
Uma string anexada ao objeto. Muitas vezes útil para exibição aos usuários.
Quando definido como true
, executa o processo para finalizar a fatura no ato de criação, alterando o status para open
ao final do processo. Se não informado ou definido como false
, a fatura permanecerá com o status draft
.
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.
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.
Data de pagamento da fatura.
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.