Buscar parcelas

Retorna todas as parcelas.

Os itens são retornados e ordenados por data de criação, com os itens mais recentes primeiro.

Authorizations

Authorization

string

header

required

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

Query Parameters

query

string

required

Uma string de busca que permite criar filtros personalizados. Filtros permitidos amountRemaining, loan.customer.document, loan.customer.name, dueDate. Para os campos que são string o único comparador válido é :. É possível utilizar os operadores AND e OR para concatenar mais de uma query, O operador lógico AND tem prioridade de agrupamento em relação ao OR. É possível utilizar os caracteres () para definir prioridade de agrupamentos.

starting_after

string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

ending_before

string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

limit

integer

default:10

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.

Response

200 - application/json

Um objeto com uma propriedade `data` que contém um array de itens começando após o item `starting_after`. Cada entrada no array é um objeto `Installment` separado. Se não houver mais itens, o array estará vazio. Essa solicitação nunca deve retornar um erro.

Uma lista de parcelas.

hasMore

boolean

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

Example:

true

data

object[]

Uma lista de parcelas

Este objeto representa uma parcela.

Show child attributes

data.id

string

Identificador exclusivo para o objeto.

Example:

"inst_5f92f01728e009f403d8502e"

data.status

enum<string>

Status da parcela

Available options:

void,

paid,

uncollectible,

unpaid

Example:

"void"

data.loan

string

Example:

"loan_631f61201fc21101870d22a"

data.payer

string

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

data.calendarDays

integer

data.workdays

integer

data.number

integer

data.amountPaid

number

data.dueDate

string

Data de vencimento da parcela

data.duePrincipal

number

data.hasInterest

boolean

data.postFixedAmount

number

data.preFixedAmount

number

data.principalAmortizationAmount

number

data.taxAmount

number

data.totalAmount

number

data.transactions

object

Uma lista de transações de uma parcela.

Show child attributes

data.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

data.transactions.data

object[]

Uma lista de parcelas

Show child attributes

data.transactions.data.id

string

Example:

"itsc_631f61201fc21101870d22a"

data.transactions.data.discount

number

Example:

20

data.transactions.data.fine

number

Example:

10

data.transactions.data.interest

number

Example:

5

data.transactions.data.amountPaid

number

Example:

100

data.transactions.data.invoice

string

Example:

"inv_631f61201fc21101870d22a"

data.transactions.data.installment

string

Example:

"inst_631f61201fc21101870d22a"

data.transactions.data.createdAt

string

Example:

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

data.fund

string

Identificador único do fundo

Example:

"fund_631f61201fc21101870d22a"

data.amountRemaining

number

Example:

1500

data.amountForPayment

number

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

Example:

1487.9

data.amountForPaymentDiscount

number

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

Example:

12.1

data.amountForPaymentFine

number

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

Example:

0

data.amountForPaymentInterest

number

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

Example:

0

data.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.

data.createdAt

string

Data de criação do objeto

Example:

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

data.updatedAt

string

Data de alteração do objeto

Example:

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

data.deleted

boolean

default:false

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

Example:

false