POST
/
v1
/
installments
/
{installment}
/
mark-uncollectible

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

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

Este objeto representa uma parcela.

id
string

Identificador exclusivo para o objeto.

status
enum<string>

Status da parcela

Available options:
void,
paid,
uncollectible,
unpaid
loan
string
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.

fund
string

Identificador único do fundo

amountRemaining
number
amountForPayment
number

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

amountForPaymentDiscount
number

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

amountForPaymentFine
number

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

amountForPaymentInterest
number

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

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.