Criar item da fatura

Cria um novo item da fatura.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

Chave única de idempotência para evitar duplicação de requisições.

Path Parameters

invoice

string

required

ID da fatura

Query Parameters

expand

string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

Body

application/json

Criar um item de fatura

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.

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.

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.

Response

201 - application/json

Representa uma parcela da fatura tanto para o pagamento, como para antecipação.

id

string

Identificador exclusivo para o objeto.

installment

string

Identificador que faz referência a uma parcela.

invoice

string

Identificador que faz referência a uma fatura.

amount

number

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.

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

string

Data de criação do objeto

updatedAt

string

Data de alteração do objeto

deleted

boolean

default: false

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