Pular para o conteúdo principal

Criar parcela

POST 
/v1/installments

Cria uma nova parcela.

Request​

Query Parameters

    loan stringrequired

    ID do empréstimo

    Example: loan_62d98877a224132dd75a4dfa
    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
    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:

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

    Example: id,createdAt

Header Parameters

    Idempotency-Key string

    Chave única de idempotência para evitar duplicação de requisições.

    Example: 5f92f01728e009f403d8502e
    base39-external-client-id string

    Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

Body

    payer stringrequired

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

    calendarDays integer
    workdays integer
    number integer
    dueDate daterequired

    Data de vencimento da parcela

    duePrincipal double
    hasInterest boolean
    postFixedAmount double
    preFixedAmount double
    principalAmortizationAmount double
    taxAmount double
    totalAmount doublerequired
    fund stringrequired

    Identificador único do fundo

    Example: fund_631f61201fc21101870d22a
    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.

Responses​

Retorna o objeto Installment se a criação for bem-sucedida; retorna erro se os parâmetros forem inválidos.

Schema

    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

    A parte de uma resposta da API que descreve a paginação

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