Listar parcelas

GET /v1/loans/:loan/installments

Lista parcelas de um empréstimo, ordenadas por data (mais recentes primeiro). Para quitação antecipada, inclua payment_for com a data pretendida para calcular o valor da parcela.

Request

Path Parameters

loan stringrequired

ID do empréstimo

Example: loan_5f92f01728e009f403d8502e

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.

Example: data.loan

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.

Example: obj_5f92f01728e009f403d8502e

ending_before string

Example: obj_5f92f01728e009f403d8502e

limit integer

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

Default value: 10

Example: 10

payment_for date

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.

Example: 2019-08-24

status any

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

Examples:

single
list

Valor único

Example: void

Lista

Example: void,paid

due_date_start date

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

Example: 2022-12-01

due_date_end date

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

Example: 2023-01-01

payer string

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

Examples:

single
list

Valor único

Example: cust_631f61201fc21101870d22a2

Lista

Example: cust_631f61201fc21101870d22a2,cust_636a54c6beba11ba7c0637f6

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.

Examples:

inclusao
exclusao

Retorna apenas os campos `id` e `createdAt`.

Example: id,createdAt

Retorna todos os campos, exceto `id`.

Example: -id

Responses

Retorna o objeto Loan para um ID válido. Se o empréstimo estiver excluído, a propriedade deleted será true.

application/json

Schema
Example (from schema)

Schema

hasMoreboolean

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

Array [

idstring

Identificador exclusivo para o objeto.

Example: inst_5f92f01728e009f403d8502e

customerstring

Identificador do cliente responsável.

Example: cust_5f92f01728e009f403d8502e

statusstring

Status da parcela

Possible values: [void, paid, uncollectible, unpaid]

Example: void

loanstring

Example: loan_631f61201fc21101870d22a

payerstring

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

calendarDaysinteger

workdaysinteger

numberinteger

amountPaidnumber

dueDatedate

Data de vencimento da parcela

duePrincipaldouble

hasInterestboolean

postFixedAmountdouble

preFixedAmountdouble

principalAmortizationAmountdouble

taxAmountdouble

totalAmountdouble

transactions

object

Uma lista de transações de uma parcela.

hasMoreboolean

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

Array [

idstring

Example: itsc_631f61201fc21101870d22a

discountdouble

Example: 20

finedouble

Example: 10

interestdouble

Example: 5

amountPaiddouble

Example: 100

invoicestring

Example: inv_631f61201fc21101870d22a

installmentstring

Example: inst_631f61201fc21101870d22a

createdAtdate-time

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

]

fundstring

Identificador único do fundo

Example: fund_631f61201fc21101870d22a

amountRemainingdouble

Example: 1500

amountForPaymentdouble

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

Example: 1487.9

amountForPaymentDiscountdouble

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

Example: 12.1

amountForPaymentFinedouble

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

Example: 0

amountForPaymentInterestdouble

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

Example: 0

allowCustomerPayerboolean

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

Example: true

metadataobject

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.

createdAtdate-time

Data de criação do objeto

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

updatedAtdate-time

Data de alteração do objeto

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

deletedboolean

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

Default value: false

Example: false

createdBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

]

{
  "hasMore": true,
  "data": [
    {
      "id": "inst_5f92f01728e009f403d8502e",
      "customer": "cust_5f92f01728e009f403d8502e",
      "status": "void",
      "loan": "loan_631f61201fc21101870d22a",
      "payer": "string",
      "calendarDays": 0,
      "workdays": 0,
      "number": 0,
      "amountPaid": 0,
      "dueDate": "2024-07-29",
      "duePrincipal": 0,
      "hasInterest": true,
      "postFixedAmount": 0,
      "preFixedAmount": 0,
      "principalAmortizationAmount": 0,
      "taxAmount": 0,
      "totalAmount": 0,
      "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"
      }
    }
  ]
}

Listar parcelas

/v1/loans/:loan/installments

Request​

Path Parameters

Query Parameters

Responses​

Request

Responses