GET
/
v1
/
installments
curl --request GET \
  --url https://api.base39.io/v1/installments \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "data": [
    {
      "id": "inst_5f92f01728e009f403d8502e",
      "customer": "cust_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,
      "allowCustomerPayer": true,
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false,
      "createdBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      },
      "updatedBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
validate_customer_payment
boolean

Valida se a parcela pode entrar em uma fatura de antecipação ou refinanciamento.

​
overpaid
boolean

Com o campo definido como true, retornará apenas parcelas pagas com valor excedente.

​
id
string

ID da parcela. O valor deve ser uma string ou uma lista separada por vírgula.

​
loan
string

ID do empréstimo. O valor deve ser uma string ou uma lista separada por vírgula. Caso sejam usados os filtros payment_for ou validate_customer_payment, o campo loan será obrigatório e só poderá ser informado um único ID por requisição.

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

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

​
payment_for
string

Campo para definir o dia de pagamento do boleto. Ao enviar este campo, será realizado um cálculo de valor presente (VP) para o dia de pagamento informado.

​
status
enum<string>

O status da parcela. O valor deve ser uma string ou uma lista separada por vírgula.

Available options:
void,
paid,
uncollectible,
unpaid
Example:

"void"

​
due_date_start
string

Um filtro com base no campo dueDate. O valor deve ser uma data.

​
due_date_end
string

Um filtro com base no campo dueDate. O valor deve ser uma data.

​
payer
string

Um filtro com base no campo payer. O valor deve ser uma string ou uma lista separada por vírgula.

​
fields
string

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

​
customer
string

Um filtro com base no campo customer. O valor deve ser uma string ou uma lista separada por vírgula.

Response

200 - application/json
Objeto com `data` contendo array de `Installment` a partir de `starting_after`; vazio se não houver mais itens. Solicitação nunca retorna 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.