POST
/
v1
/
installments
/
{installment}
/
void
curl --request POST \
  --url https://api.base39.io/v1/installments/{installment}/void \
  --header 'Authorization: Bearer <token>'
{
  "id": "inst_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,
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false
}

Authorizations

​
Authorization
string
header
required

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.

Path Parameters

​
installment
string
required

ID da parcela

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[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Response

200 - application/json

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

Este objeto representa uma parcela.