Anular parcela

POST 
/v1/installments/:installment/void

Anula uma parcela.

Request

Path Parameters

installment stringrequired
ID da parcela
Example: inst_5f92f01728e009f403d8502e

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

inclusao

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

Example: id,createdAt

exclusao

Retorna todos os campos, exceto `id`.

Example: -id

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.

Responses

200

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

application/json

Schema

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

Example (from schema)

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

Loading...