Listar parcelas

GET 
/v1/installments

Retorna todas as parcelas, ordenadas por data de criação, com as mais recentes primeiro.

Request

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.

Examples:

single

Valor único

Example: inst_5f92f01728e009f403d8502e

list

Lista

Example: inst_5f92f01728e009f403d8502e,inst_5f92f01728e009f403d8656a

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.

Examples:

single

Valor único

Example: loan_5f92f01728e009f403d8502e

list

Lista

Example: loan_5f92f01728e009f403d8502e,loan_6671ff8a96f20b37da55d889

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

Valor único

Example: void

list

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

Valor único

Example: cust_631f61201fc21101870d22a2

list

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

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

Example: id,createdAt

exclusao

Retorna todos os campos, exceto `id`.

Example: -id

customer string

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

Examples:

single

Valor único

Example: cust_631f61201fc21101870d22a2

list

Lista

Example: cust_631f61201fc21101870d22a2,cust_636a54c6beba11ba7c0637f6

Responses

200

Objeto com data contendo array de Installment a partir de starting_after; vazio se não houver mais itens. Solicitação nunca retorna erro.

application/json

Schema

Schema

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

Array [

id string

Identificador exclusivo para o objeto.

Example: inst_5f92f01728e009f403d8502e

customer string

Identificador do cliente responsável.

Example: cust_5f92f01728e009f403d8502e

status string

Status da parcela

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

Example: void

loan string

Example: loan_631f61201fc21101870d22a

payer string

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

calendarDays integer

workdays integer

number integer

amountPaid number

dueDate date

Data de vencimento da parcela

duePrincipal double

hasInterest boolean

postFixedAmount double

preFixedAmount double

principalAmortizationAmount double

taxAmount double

totalAmount double

transactions

object

Uma lista de transações de uma parcela.

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

Array [

id string

Example: itsc_631f61201fc21101870d22a

discount double

Example: 20

fine double

Example: 10

interest double

Example: 5

amountPaid double

Example: 100

invoice string

Example: inv_631f61201fc21101870d22a

installment string

Example: inst_631f61201fc21101870d22a

createdAt date-time

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

]

fund string

Identificador único do fundo

Example: fund_631f61201fc21101870d22a

amountRemaining double

Example: 1500

amountForPayment double

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

Example: 1487.9

amountForPaymentDiscount double

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

Example: 12.1

amountForPaymentFine double

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

Example: 0

amountForPaymentInterest double

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

Example: 0

allowCustomerPayer boolean

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

Example: true

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 date-time

Data de criação do objeto

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

updatedAt date-time

Data de alteração do objeto

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

deleted boolean

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

Default value: false

Example: false

createdBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

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.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

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.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

]

Example (from schema)

{
  "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"
      }
    }
  ]
}

Loading...