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

    payerstringrequired

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

    calendarDaysinteger
    workdaysinteger
    numberinteger
    dueDatedaterequired

    Data de vencimento da parcela

    duePrincipaldouble
    hasInterestboolean
    postFixedAmountdouble
    preFixedAmountdouble
    principalAmortizationAmountdouble
    taxAmountdouble
    totalAmountdoublerequired
    fundstringrequired

    Identificador único do fundo

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

Responses​

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

Schema

    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

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

    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