POST
/
v1
/
loans
/
{loan}
/
installments

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

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

base39-external-client-id
string

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

Path Parameters

loan
string
required

ID do empréstimo

Query Parameters

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.

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.

Body

application/json
payer
string
required

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

calendarDays
integer
workdays
integer
number
integer
dueDate
string
required

Data de vencimento da parcela

duePrincipal
number
hasInterest
boolean
postFixedAmount
number
preFixedAmount
number
principalAmortizationAmount
number
taxAmount
number
totalAmount
number
required
fund
string
required

Identificador único do fundo

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.

Response

200 - application/json
id
string

Identificador exclusivo para o objeto.

customer
string

Identificador do cliente responsável.

status
enum<string>

Status da parcela

Available options:
void,
paid,
uncollectible,
unpaid
loan
string
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

amountRemaining
number
amountForPayment
number

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

amountForPaymentDiscount
number

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

amountForPaymentFine
number

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

amountForPaymentInterest
number

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

allowCustomerPayer
boolean

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

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

updatedAt
string

Data de alteração do objeto

deleted
boolean
default: false

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

createdBy
object
updatedBy
object
Criar transaçãoMarcar empréstimo como pendente