POST
/
v1
/
installments
/
{installment}
/
void
curl --request POST \
  --url https://api.base39.io/v1/installments/{installment}/void \
  --header 'Authorization: Bearer <token>'
{
  "id": "inst_5f92f01728e009f403d8502e",
  "customer": "cust_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,
  "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"
  }
}

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.

​
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

​
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

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.

Response

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

Este objeto representa uma parcela.

​
id
string

Identificador exclusivo para o objeto.

Example:

"inst_5f92f01728e009f403d8502e"

​
customer
string

Identificador do cliente responsável.

Example:

"cust_5f92f01728e009f403d8502e"

​
status
enum<string>

Status da parcela

Available options:
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
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

Example:

"fund_631f61201fc21101870d22a"

​
amountRemaining
number
Example:

1500

​
amountForPayment
number

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

Example:

1487.9

​
amountForPaymentDiscount
number

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

Example:

12.1

​
amountForPaymentFine
number

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

Example:

0

​
amountForPaymentInterest
number

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
string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
updatedAt
string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
deleted
boolean
default:false

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

Example:

false

​
createdBy
object
​
updatedBy
object