InvoiceCreate

Criar uma fatura

payer stringrequired

Responsável pelo pagamento. Pode ser um customer ou company.

beneficiary stringrequired

Fundo que vai receber o pagamento.

dueDate date

A data de vencimento da fatura.

type stringrequired
Tipo da fatura
Possible values: [pay_off, customer_recurring, company_recurring]
Example: pay_off
purpose string
Propósito da fatura
Possible values: [cancellation, customer_refinance, employment_terminated, external_collector, no_funds, regular, requested_by_company, requested_by_customer, requested_by_insurance]
Example: regular
description string

Uma string anexada ao objeto. Muitas vezes útil para exibição aos usuários.

items

object[]

Array [

id string

Identificador exclusivo para o objeto.

Example: item_5f92f01728e009f403d8502e

installment string

Identificador que faz referência a uma parcela.

Example: inst_631a1f531a40784a5b1df6ed

invoice string

Identificador que faz referência a uma fatura.

Example: inv_631a1f531a40784a4b0df5ed

amount double

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 double

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

fine double

Valor da multa

interest double

Valor do juros

description string

Descrição do item.

purposeKey string

Chave de propósito do item da fatura.

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.

createdAt date-time

Data de criação do objeto

Example: 2023-08-25T22:38:41.134Z

updatedAt date-time

Data de alteração do objeto

Example: 2023-08-25T22:38:41.134Z

deleted boolean

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Default value: false

Example: false

createdBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

]

autoFinalize boolean

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.

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.
Example: true
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.
Example: true
paidAt date

Data de pagamento da fatura.

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.