Anular parcela

Anula uma parcela.

Authorizations

Authorization

string

header

required

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

installment

string

required

ID da parcela

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.

fields

string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Response

200 - application/json

Retorna o objeto `Installment` se a mudança de estado for bem-sucedida. Retorna um erro se os parâmetros de alteração forem inválidos.

Este objeto representa uma parcela.

id

string

Identificador exclusivo para o objeto.

Example:

"inst_5f92f01728e009f403d8502e"

status

enum<string>

Status da parcela

Available options:

void,

paid,

uncollectible,

unpaid

Example:

"void"

loan

string

Example:

"loan_631f61201fc21101870d22a"

payer

string

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

calendarDays

integer

workdays

integer

number

integer

amountPaid

number

dueDate

string

Data de vencimento da parcela

duePrincipal

number

hasInterest

boolean

postFixedAmount

number

preFixedAmount

number

principalAmortizationAmount

number

taxAmount

number

totalAmount

number

transactions

object

Uma lista de transações de uma parcela.

Show child attributes

transactions.hasMore

boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example:

true

transactions.data

object[]

Uma lista de parcelas

Show child attributes

transactions.data.id

string

Example:

"itsc_631f61201fc21101870d22a"

transactions.data.discount

number

Example:

20

transactions.data.fine

number

Example:

10

transactions.data.interest

number

Example:

5

transactions.data.amountPaid

number

Example:

100

transactions.data.invoice

string

Example:

"inv_631f61201fc21101870d22a"

transactions.data.installment

string

Example:

"inst_631f61201fc21101870d22a"

transactions.data.createdAt

string

Example:

"2020-01-01T00:00:00.000Z"

fund

string

Identificador único do fundo

Example:

"fund_631f61201fc21101870d22a"

amountRemaining

number

Example:

1500

amountForPayment

number

Valor para pagamento, será apresentado caso seja informado o parâmetro payment_for.

Example:

1487.9

amountForPaymentDiscount

number

Desconto aplicado ao valor para pagamento, será apresentado caso seja informado o parâmetro payment_for.

Example:

12.1

amountForPaymentFine

number

Multa aplicada ao valor para pagamento, será apresentado caso seja informado o parâmetro payment_for.

Example:

0

amountForPaymentInterest

number

Juros aplicados ao valor para pagamento, será apresentado caso seja informado o parâmetro payment_for.

Example:

0

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

Example:

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

updatedAt

string

Data de alteração do objeto

Example:

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

deleted

boolean

default:false

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

Example:

false