Installments

Uma lista de parcelas.

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

]

Installments

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