Skip to main content
GET
/
v1
/
installments
/
search
Buscar parcelas
curl --request GET \
  --url https://api.base39.io/v1/installments/search \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "data": [
    {
      "id": "inst_5f92f01728e009f403d8502e",
      "status": "void",
      "loan": "loan_631f61201fc21101870d22a",
      "payer": "<string>",
      "calendarDays": 123,
      "workdays": 123,
      "number": 123,
      "amountPaid": 123,
      "dueDate": "2023-12-25",
      "duePrincipal": 123,
      "hasInterest": true,
      "postFixedAmount": 123,
      "preFixedAmount": 123,
      "principalAmortizationAmount": 123,
      "taxAmount": 123,
      "totalAmount": 123,
      "transactions": {
        "hasMore": true,
        "data": [
          {
            "id": "itsc_631f61201fc21101870d22a",
            "discount": 20,
            "fine": 10,
            "interest": 5,
            "amountPaid": 100,
            "invoice": "inv_631f61201fc21101870d22a",
            "installment": "inst_631f61201fc21101870d22a",
            "createdAt": "2020-01-01T00:00:00.000Z"
          }
        ]
      },
      "fund": "fund_631f61201fc21101870d22a",
      "amountRemaining": 1500,
      "amountForPayment": 1487.9,
      "amountForPaymentDiscount": 12.1,
      "amountForPaymentFine": 0,
      "amountForPaymentInterest": 0,
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false
    }
  ]
}

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. A parte de uma resposta da API que descreve a paginação

​
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
Installment · object[]

Uma lista de parcelas