Installment

Este objeto representa uma parcela.

string

Identificador exclusivo para o objeto.

Example:

"inst_5f92f01728e009f403d8502e"

customer

string

Identificador do cliente responsável.

Example:

"cust_5f92f01728e009f403d8502e"

status

enum<string>

Status da parcela

Available options:

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

string

Data de vencimento da parcela

duePrincipal

number

hasInterest

boolean

postFixedAmount

number

preFixedAmount

number

principalAmortizationAmount

number

taxAmount

number

totalAmount

number

transactions

object

Uma lista de transações de uma parcela.

fund

string

Identificador único do fundo

Example:

"fund_631f61201fc21101870d22a"

amountRemaining

number

Example:

1500

amountForPayment

number

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

Example:

1487.9

amountForPaymentDiscount

number

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

Example:

12.1

amountForPaymentFine

number

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

Example:

0

amountForPaymentInterest

number

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

string

Data de criação do objeto

Example:

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

updatedAt

string

Data de alteração do objeto

Example:

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

deleted

boolean

default:false

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

Example:

false

createdBy

object

updatedBy

object

Permissions Installments

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

Empréstimos

Empresas

Clientes

Fundos

Eventos

Cobrança

Arquivos

Configurações

Entidades

Automações

Modelos