# Cobrança — Parcelamentos (UY3)

> 13 endpoints. Placeholders: `{{baseUrl}}` e `{{token}}`.

## Autenticação

Envie o token em toda requisição no header `Authorization: Bearer {{token}}` (JWT do AWS Cognito). Integrações servidor-a-servidor podem usar `X-Api-Key`. Todo tráfego é HTTPS; a credencial nunca vai na URL nem em query string.

## Parcelamentos

Crie e acompanhe parcelamentos de cobranças.

### GET /api/v1/Installment

**Método de visualização da lista de parcelamentos** — Lista e filtra registros de api.

Método de visualização da lista de parcelamentos.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `WalletsCode` | query | `array de integer (int64)` | opcional | — | `valor` |
| `Tenant` | query | `string` | opcional | — | `uy3` |
| `StatusesValue` | query | `array de string` | opcional | — | `valor` |
| `PayerName` | query | `string` | opcional | — | `valor` |
| `PayerRegistrationNumber` | query | `string` | opcional | — | `valor` |
| `BillingCount` | query | `integer (int64)` | opcional | — | `10` |
| `InitialCreatedDate` | query | `string (date-time)` | opcional | — | `valor` |
| `FinalCreatedDate` | query | `string (date-time)` | opcional | — | `valor` |
| `FirstInstructionDebtCollection` | query | `string` | opcional | — | `valor` |
| `Operation` | query | `string` | opcional | — | `valor` |
| `IsDeleted` | query | `boolean` | opcional | — | `true` |
| `Page` | query | `integer` | opcional | — | `10` |
| `Size` | query | `integer` | opcional | — | `10` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `data` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `page` | `integer` | opcional | — | — | `0` |
| `totalPages` | `integer` | opcional | — | — | `0` |
| `totalItems` | `integer` | opcional | — | — | `0` |
| `isCountTruncated` | `boolean` | opcional | — | — | `true` |

Detalhe de `data`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `walletCode` | `integer (int64)` | opcional | — | — | `0` |
| `billingCreateTypeValue` | `string` | opcional | — | — | `"texto"` |
| `billingCreateTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `operations` | `array de string` | opcional | — | — | `[ … ]` |
| `admissionDates` | `array de string (date-time)` | opcional | — | — | `[ … ]` |
| `billingSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `billingSettingDisplay` | `string` | opcional | — | — | `"texto"` |
| `communicationSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `communicationSettingDisplay` | `string` | opcional | — | — | `"texto"` |
| `reference` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `tags` | `array de string` | opcional | — | — | `[ … ]` |
| `billings` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `payer` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `guarantor` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `billingCount` | `integer` | opcional | — | — | `0` |
| `firstInstructionDebtCollection` | `string` | opcional | — | — | `"texto"` |
| `secondInstructionDebtCollection` | `integer` | opcional | — | — | `0` |
| `statusValue` | `string` | opcional | — | — | `"texto"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `registered` | `boolean` | opcional | — | — | `true` |
| `bankCode` | `string` | opcional | — | — | `"texto"` |
| `walletNumber` | `integer` | opcional | — | — | `0` |
| `latePaymentInterestAmountPerDay` | `integer` | opcional | — | — | `0` |
| `creditTypeValue` | `string` | opcional | — | — | `"texto"` |
| `creditTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `apr` | `number (double)` | opcional | — | — | `1.99` |
| `warrantyRegistrationOffice` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"None"` |
| `warrantyRegistrationOfficeDisplay` | `string` | opcional | — | — | `"texto"` |
| `calculationCriteria` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"V252DiasUteis"` |
| `calculationCriteriaDisplay` | `string` | opcional | — | — | `"texto"` |
| `interestTypeValue` | `string` | opcional | — | — | `"texto"` |
| `interestTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `interestAmount` | `number (decimal)` | opcional | — | — | `1000` |
| `fineTypeValue` | `string` | opcional | — | — | `"texto"` |
| `fineTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `fineAmount` | `number (decimal)` | opcional | — | — | `1000` |
| `predecessorInstallmentId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `successorInstallmentId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Detalhe de `billings`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `externalId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `billingStatus` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `isAnticipatedBilling` | `boolean` | opcional | — | — | `true` |

Exemplo:

```json
{
  "data": [
    {
      "id": "texto",
      "walletCode": 0,
      "billingCreateTypeValue": "texto",
      "billingCreateTypeDisplay": "texto",
      "description": "texto",
      "operations": [
        "texto"
      ],
      "admissionDates": [
        "2025-08-11T13:45:00Z"
      ],
      "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "billingSettingDisplay": "texto",
      "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "communicationSettingDisplay": "texto",
      "reference": {
        "resource": {},
        "id": "texto"
      },
      "tags": [
        "texto"
      ],
      "billings": [
        {}
      ],
      "payer": {
        "name": "Fulano de Tal",
        "personTypeValue": "texto",
        "personTypeValueDisplay": "texto",
        "registrationNumber": "12345678909",
        "zipCode": "01310930",
        "addressName": "Fulano de Tal",
        "addressNumber": "texto",
        "addressComplement": "texto",
        "email": "cliente@exemplo.com.br"
      },
      "guarantor": {
        "name": "Fulano de Tal",
        "registrationNumber": "12345678909"
      },
      "billingCount": 0,
      "firstInstructionDebtCollection": "texto",
      "secondInstructionDebtCollection": 0,
      "statusValue": "texto",
      "statusDisplay": "texto",
      "registered": true,
      "bankCode": "texto",
      "walletNumber": 0,
      "latePaymentInterestAmountPerDay": 0,
      "creditTypeValue": "texto",
      "creditTypeDisplay": "texto",
      "createdAt": "2025-08-11T13:45:00Z",
      "apr": 1.99,
      "warrantyRegistrationOffice": "None",
      "warrantyRegistrationOfficeDisplay": "texto",
      "calculationCriteria": "V252DiasUteis",
      "calculationCriteriaDisplay": "texto",
      "interestTypeValue": "texto",
      "interestTypeValueDisplay": "texto",
      "interestAmount": 1000,
      "fineTypeValue": "texto",
      "fineTypeValueDisplay": "texto",
      "fineAmount": 1000,
      "predecessorInstallmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "successorInstallmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "page": 0,
  "totalPages": 0,
  "totalItems": 0,
  "isCountTruncated": true
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/api/v1/Installment" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /api/v1/Installment

**Método de cadastro de um parcelamento** — Cria um novo registro de api.

Método de cadastro de um parcelamento.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `idempotence` | query | `string` | opcional | — | `valor` |
| `register` | query | `boolean` | opcional | — | `true` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `walletCode` | `integer (int64)` | opcional | — | — | `0` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `operations` | `array de string` | opcional | — | — | `[ … ]` |
| `admissionDates` | `array de string (date-time)` | opcional | — | — | `[ … ]` |
| `billingSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `communicationSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `reference` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `tags` | `array de string` | opcional | — | — | `[ … ]` |
| `payer` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `guarantor` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `billings` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `firstInstructionDebtCollection` | `string` | opcional | — | — | `"texto"` |
| `secondInstructionDebtCollection` | `integer` | opcional | — | — | `0` |
| `bankCode` | `string` | opcional | — | — | `"texto"` |
| `walletNumber` | `integer` | opcional | — | — | `0` |
| `latePaymentInterestAmountPerDay` | `integer` | opcional | — | — | `0` |
| `creditTypeValue` | `string` | opcional | — | — | `"texto"` |
| `billingCreateTypeValue` | `string` | opcional | — | — | `"texto"` |
| `installmentsToCancel` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `interestTypeValue` | `string` | opcional | — | — | `"texto"` |
| `interestAmount` | `number (decimal)` | opcional | — | — | `1000` |
| `fineTypeValue` | `string` | opcional | — | — | `"texto"` |
| `interestCodeValue` | `string` | opcional | — | — | `"texto"` |
| `fineAmount` | `number (decimal)` | opcional | — | — | `1000` |
| `apr` | `number (double)` | opcional | — | — | `1.99` |

Detalhe de `billings`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `externalId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `documentNumber` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `dueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `iof` | `string` | opcional | — | — | `"texto"` |
| `deduction` | `integer` | opcional | — | — | `0` |
| `participantControlNumber` | `string` | opcional | — | — | `"texto"` |
| `discount` | `integer` | opcional | — | — | `0` |
| `discountLimitDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `discount2` | `integer` | opcional | — | — | `0` |
| `discountLimitDate2` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `discount3` | `integer` | opcional | — | — | `0` |
| `discountLimitDate3` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `installmentsToCancel`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `installmentStatus` | `string` | opcional | — | `Created`, `Registered`, `Paid`, `Cancelled`, `Renegotiated`, `Refinanced` | `"Created"` |

Exemplo:

```json
{
  "walletCode": 0,
  "description": "texto",
  "operations": [
    "texto"
  ],
  "admissionDates": [
    "2025-08-11T13:45:00Z"
  ],
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": {
    "resource": "CreditNote",
    "id": "texto"
  },
  "tags": [
    "texto"
  ],
  "payer": {
    "name": "Fulano de Tal",
    "personTypeValue": "texto",
    "personTypeValueDisplay": "texto",
    "registrationNumber": "12345678909",
    "zipCode": "01310930",
    "addressName": "Fulano de Tal",
    "addressNumber": "texto",
    "addressComplement": "texto",
    "email": "cliente@exemplo.com.br"
  },
  "guarantor": {
    "name": "Fulano de Tal",
    "registrationNumber": "12345678909"
  },
  "billings": [
    {
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "documentNumber": "texto",
      "amount": 0,
      "dueDate": "2025-08-11T13:45:00Z",
      "iof": "texto",
      "deduction": 0,
      "participantControlNumber": "texto",
      "discount": 0,
      "discountLimitDate": "2025-08-11T13:45:00Z",
      "discount2": 0,
      "discountLimitDate2": "2025-08-11T13:45:00Z",
      "discount3": 0,
      "discountLimitDate3": "2025-08-11T13:45:00Z"
    }
  ],
  "firstInstructionDebtCollection": "texto",
  "secondInstructionDebtCollection": 0,
  "bankCode": "texto",
  "walletNumber": 0,
  "latePaymentInterestAmountPerDay": 0,
  "creditTypeValue": "texto",
  "billingCreateTypeValue": "texto",
  "installmentsToCancel": [
    {
      "id": "texto",
      "installmentStatus": "Created"
    }
  ],
  "interestTypeValue": "texto",
  "interestAmount": 1000,
  "fineTypeValue": "texto",
  "interestCodeValue": "texto",
  "fineAmount": 1000,
  "apr": 1.99
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `walletCode` | `integer (int64)` | opcional | — | — | `0` |
| `billingCreateTypeValue` | `string` | opcional | — | — | `"texto"` |
| `billingCreateTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `operations` | `array de string` | opcional | — | — | `[ … ]` |
| `admissionDates` | `array de string (date-time)` | opcional | — | — | `[ … ]` |
| `billingSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `billingSettingDisplay` | `string` | opcional | — | — | `"texto"` |
| `communicationSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `communicationSettingDisplay` | `string` | opcional | — | — | `"texto"` |
| `reference` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `tags` | `array de string` | opcional | — | — | `[ … ]` |
| `billings` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `payer` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `guarantor` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `billingCount` | `integer` | opcional | — | — | `0` |
| `firstInstructionDebtCollection` | `string` | opcional | — | — | `"texto"` |
| `secondInstructionDebtCollection` | `integer` | opcional | — | — | `0` |
| `statusValue` | `string` | opcional | — | — | `"texto"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `registered` | `boolean` | opcional | — | — | `true` |
| `bankCode` | `string` | opcional | — | — | `"texto"` |
| `walletNumber` | `integer` | opcional | — | — | `0` |
| `latePaymentInterestAmountPerDay` | `integer` | opcional | — | — | `0` |
| `creditTypeValue` | `string` | opcional | — | — | `"texto"` |
| `creditTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `apr` | `number (double)` | opcional | — | — | `1.99` |
| `warrantyRegistrationOffice` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"None"` |
| `warrantyRegistrationOfficeDisplay` | `string` | opcional | — | — | `"texto"` |
| `calculationCriteria` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"V252DiasUteis"` |
| `calculationCriteriaDisplay` | `string` | opcional | — | — | `"texto"` |
| `interestTypeValue` | `string` | opcional | — | — | `"texto"` |
| `interestTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `interestAmount` | `number (decimal)` | opcional | — | — | `1000` |
| `fineTypeValue` | `string` | opcional | — | — | `"texto"` |
| `fineTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `fineAmount` | `number (decimal)` | opcional | — | — | `1000` |
| `predecessorInstallmentId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `successorInstallmentId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Detalhe de `billings`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `externalId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `billingStatus` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `isAnticipatedBilling` | `boolean` | opcional | — | — | `true` |

Exemplo:

```json
{
  "id": "texto",
  "walletCode": 0,
  "billingCreateTypeValue": "texto",
  "billingCreateTypeDisplay": "texto",
  "description": "texto",
  "operations": [
    "texto"
  ],
  "admissionDates": [
    "2025-08-11T13:45:00Z"
  ],
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "billingSettingDisplay": "texto",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingDisplay": "texto",
  "reference": {
    "resource": "CreditNote",
    "id": "texto"
  },
  "tags": [
    "texto"
  ],
  "billings": [
    {
      "id": "texto",
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "billingStatus": {
        "type": {},
        "message": "texto"
      },
      "isAnticipatedBilling": true
    }
  ],
  "payer": {
    "name": "Fulano de Tal",
    "personTypeValue": "texto",
    "personTypeValueDisplay": "texto",
    "registrationNumber": "12345678909",
    "zipCode": "01310930",
    "addressName": "Fulano de Tal",
    "addressNumber": "texto",
    "addressComplement": "texto",
    "email": "cliente@exemplo.com.br"
  },
  "guarantor": {
    "name": "Fulano de Tal",
    "registrationNumber": "12345678909"
  },
  "billingCount": 0,
  "firstInstructionDebtCollection": "texto",
  "secondInstructionDebtCollection": 0,
  "statusValue": "texto",
  "statusDisplay": "texto",
  "registered": true,
  "bankCode": "texto",
  "walletNumber": 0,
  "latePaymentInterestAmountPerDay": 0,
  "creditTypeValue": "texto",
  "creditTypeDisplay": "texto",
  "createdAt": "2025-08-11T13:45:00Z",
  "apr": 1.99,
  "warrantyRegistrationOffice": "None",
  "warrantyRegistrationOfficeDisplay": "texto",
  "calculationCriteria": "V252DiasUteis",
  "calculationCriteriaDisplay": "texto",
  "interestTypeValue": "texto",
  "interestTypeValueDisplay": "texto",
  "interestAmount": 1000,
  "fineTypeValue": "texto",
  "fineTypeValueDisplay": "texto",
  "fineAmount": 1000,
  "predecessorInstallmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "successorInstallmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/Installment" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "walletCode": 0,
  "description": "texto",
  "operations": [
    "texto"
  ],
  "admissionDates": [
    "2025-08-11T13:45:00Z"
  ],
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": {
    "resource": "CreditNote",
    "id": "texto"
  },
  "tags": [
    "texto"
  ],
  "payer": {
    "name": "Fulano de Tal",
    "personTypeValue": "texto",
    "personTypeValueDisplay": "texto",
    "registrationNumber": "12345678909",
    "zipCode": "01310930",
    "addressName": "Fulano de Tal",
    "addressNumber": "texto",
    "addressComplement": "texto",
    "email": "cliente@exemplo.com.br"
  },
  "guarantor": {
    "name": "Fulano de Tal",
    "registrationNumber": "12345678909"
  },
  "billings": [
    {
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "documentNumber": "texto",
      "amount": 0,
      "dueDate": "2025-08-11T13:45:00Z",
      "iof": "texto",
      "deduction": 0,
      "participantControlNumber": "texto",
      "discount": 0,
      "discountLimitDate": "2025-08-11T13:45:00Z",
      "discount2": 0,
      "discountLimitDate2": "2025-08-11T13:45:00Z",
      "discount3": 0,
      "discountLimitDate3": "2025-08-11T13:45:00Z"
    }
  ],
  "firstInstructionDebtCollection": "texto",
  "secondInstructionDebtCollection": 0,
  "bankCode": "texto",
  "walletNumber": 0,
  "latePaymentInterestAmountPerDay": 0,
  "creditTypeValue": "texto",
  "billingCreateTypeValue": "texto",
  "installmentsToCancel": [
    {
      "id": "texto",
      "installmentStatus": "Created"
    }
  ],
  "interestTypeValue": "texto",
  "interestAmount": 1000,
  "fineTypeValue": "texto",
  "interestCodeValue": "texto",
  "fineAmount": 1000,
  "apr": 1.99
}'
```

---

### GET /api/v1/Installment/{installmentId}

**Método de visualização de um parcelamento específico** — Consulta api pelo identificador informado na rota.

Método de visualização de um parcelamento específico.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `installmentId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `walletCode` | `integer (int64)` | opcional | — | — | `0` |
| `billingCreateTypeValue` | `string` | opcional | — | — | `"texto"` |
| `billingCreateTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `operations` | `array de string` | opcional | — | — | `[ … ]` |
| `admissionDates` | `array de string (date-time)` | opcional | — | — | `[ … ]` |
| `billingSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `billingSettingDisplay` | `string` | opcional | — | — | `"texto"` |
| `communicationSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `communicationSettingDisplay` | `string` | opcional | — | — | `"texto"` |
| `reference` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `tags` | `array de string` | opcional | — | — | `[ … ]` |
| `billings` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `payer` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `guarantor` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `billingCount` | `integer` | opcional | — | — | `0` |
| `firstInstructionDebtCollection` | `string` | opcional | — | — | `"texto"` |
| `secondInstructionDebtCollection` | `integer` | opcional | — | — | `0` |
| `statusValue` | `string` | opcional | — | — | `"texto"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `registered` | `boolean` | opcional | — | — | `true` |
| `bankCode` | `string` | opcional | — | — | `"texto"` |
| `walletNumber` | `integer` | opcional | — | — | `0` |
| `latePaymentInterestAmountPerDay` | `integer` | opcional | — | — | `0` |
| `creditTypeValue` | `string` | opcional | — | — | `"texto"` |
| `creditTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `apr` | `number (double)` | opcional | — | — | `1.99` |
| `warrantyRegistrationOffice` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"None"` |
| `warrantyRegistrationOfficeDisplay` | `string` | opcional | — | — | `"texto"` |
| `calculationCriteria` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"V252DiasUteis"` |
| `calculationCriteriaDisplay` | `string` | opcional | — | — | `"texto"` |
| `interestTypeValue` | `string` | opcional | — | — | `"texto"` |
| `interestTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `interestAmount` | `number (decimal)` | opcional | — | — | `1000` |
| `fineTypeValue` | `string` | opcional | — | — | `"texto"` |
| `fineTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `fineAmount` | `number (decimal)` | opcional | — | — | `1000` |
| `predecessorInstallmentId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `successorInstallmentId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Detalhe de `billings`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `externalId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `billingStatus` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `isAnticipatedBilling` | `boolean` | opcional | — | — | `true` |

Exemplo:

```json
{
  "id": "texto",
  "walletCode": 0,
  "billingCreateTypeValue": "texto",
  "billingCreateTypeDisplay": "texto",
  "description": "texto",
  "operations": [
    "texto"
  ],
  "admissionDates": [
    "2025-08-11T13:45:00Z"
  ],
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "billingSettingDisplay": "texto",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingDisplay": "texto",
  "reference": {
    "resource": "CreditNote",
    "id": "texto"
  },
  "tags": [
    "texto"
  ],
  "billings": [
    {
      "id": "texto",
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "billingStatus": {
        "type": {},
        "message": "texto"
      },
      "isAnticipatedBilling": true
    }
  ],
  "payer": {
    "name": "Fulano de Tal",
    "personTypeValue": "texto",
    "personTypeValueDisplay": "texto",
    "registrationNumber": "12345678909",
    "zipCode": "01310930",
    "addressName": "Fulano de Tal",
    "addressNumber": "texto",
    "addressComplement": "texto",
    "email": "cliente@exemplo.com.br"
  },
  "guarantor": {
    "name": "Fulano de Tal",
    "registrationNumber": "12345678909"
  },
  "billingCount": 0,
  "firstInstructionDebtCollection": "texto",
  "secondInstructionDebtCollection": 0,
  "statusValue": "texto",
  "statusDisplay": "texto",
  "registered": true,
  "bankCode": "texto",
  "walletNumber": 0,
  "latePaymentInterestAmountPerDay": 0,
  "creditTypeValue": "texto",
  "creditTypeDisplay": "texto",
  "createdAt": "2025-08-11T13:45:00Z",
  "apr": 1.99,
  "warrantyRegistrationOffice": "None",
  "warrantyRegistrationOfficeDisplay": "texto",
  "calculationCriteria": "V252DiasUteis",
  "calculationCriteriaDisplay": "texto",
  "interestTypeValue": "texto",
  "interestTypeValueDisplay": "texto",
  "interestAmount": 1000,
  "fineTypeValue": "texto",
  "fineTypeValueDisplay": "texto",
  "fineAmount": 1000,
  "predecessorInstallmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "successorInstallmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/api/v1/Installment/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### PATCH /api/v1/Installment/{installmentId}

**Método de atualização de um parcelamento específico** — Atualiza parcialmente um registro de api.

Método de atualização de um parcelamento específico.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `installmentId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `description` | `string` | opcional | — | — | `"texto"` |
| `operations` | `array de string` | opcional | — | — | `[ … ]` |
| `admissionDates` | `array de string (date-time)` | opcional | — | — | `[ … ]` |
| `billingSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `communicationSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `reference` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `tags` | `array de string` | opcional | — | — | `[ … ]` |
| `payer` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `guarantor` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `firstInstructionDebtCollection` | `string` | opcional | — | — | `"texto"` |
| `secondInstructionDebtCollection` | `integer` | opcional | — | — | `0` |
| `bankCode` | `string` | opcional | — | — | `"texto"` |
| `walletNumber` | `integer` | opcional | — | — | `0` |
| `latePaymentInterestAmountPerDay` | `integer` | opcional | — | — | `0` |
| `creditTypeValue` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "description": "texto",
  "operations": [
    "texto"
  ],
  "admissionDates": [
    "2025-08-11T13:45:00Z"
  ],
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": {
    "resource": "CreditNote",
    "id": "texto"
  },
  "tags": [
    "texto"
  ],
  "payer": {
    "name": "Fulano de Tal",
    "personTypeValue": "texto",
    "personTypeValueDisplay": "texto",
    "registrationNumber": "12345678909",
    "zipCode": "01310930",
    "addressName": "Fulano de Tal",
    "addressNumber": "texto",
    "addressComplement": "texto",
    "email": "cliente@exemplo.com.br"
  },
  "guarantor": {
    "name": "Fulano de Tal",
    "registrationNumber": "12345678909"
  },
  "firstInstructionDebtCollection": "texto",
  "secondInstructionDebtCollection": 0,
  "bankCode": "texto",
  "walletNumber": 0,
  "latePaymentInterestAmountPerDay": 0,
  "creditTypeValue": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `204` | Sucesso sem corpo de resposta. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X PATCH "{{baseUrl}}/api/v1/Installment/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "texto",
  "operations": [
    "texto"
  ],
  "admissionDates": [
    "2025-08-11T13:45:00Z"
  ],
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": {
    "resource": "CreditNote",
    "id": "texto"
  },
  "tags": [
    "texto"
  ],
  "payer": {
    "name": "Fulano de Tal",
    "personTypeValue": "texto",
    "personTypeValueDisplay": "texto",
    "registrationNumber": "12345678909",
    "zipCode": "01310930",
    "addressName": "Fulano de Tal",
    "addressNumber": "texto",
    "addressComplement": "texto",
    "email": "cliente@exemplo.com.br"
  },
  "guarantor": {
    "name": "Fulano de Tal",
    "registrationNumber": "12345678909"
  },
  "firstInstructionDebtCollection": "texto",
  "secondInstructionDebtCollection": 0,
  "bankCode": "texto",
  "walletNumber": 0,
  "latePaymentInterestAmountPerDay": 0,
  "creditTypeValue": "texto"
}'
```

---

### GET /api/v1/Installment/ByContract/{contractId}

**Método para buscar parcelamentos por contratoId (número da operação)** — Consulta api pelo identificador informado na rota.

Método para buscar parcelamentos por contratoId (número da operação). Localiza o CPF associado ao contrato e retorna todos os parcelamentos vinculados a esse CPF.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `contractId` | path | `string` | obrigatório | Número da operação/contrato (mesmo ID usado para consulta no Dataprev) | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `contractId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `numeroInscricaoSacado` | `string` | opcional | — | — | `"texto"` |
| `message` | `string` | opcional | — | — | `"texto"` |
| `installments` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `installments`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `walletCode` | `integer (int64)` | opcional | — | — | `0` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `operations` | `array de string` | opcional | — | — | `[ … ]` |
| `admissionDates` | `array de string (date-time)` | opcional | — | — | `[ … ]` |
| `payerName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `payerRegistrationNumber` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | — | `"texto"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `billingCount` | `integer` | opcional | — | — | `0` |
| `totalAmount` | `integer (int64)` | opcional | — | — | `0` |
| `paidAmount` | `integer (int64)` | opcional | — | — | `1` |
| `pendingAmount` | `integer (int64)` | opcional | — | — | `0` |
| `overdueBillingsCount` | `integer` | opcional | — | — | `0` |
| `paidBillingsCount` | `integer` | opcional | — | — | `1` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `registered` | `boolean` | opcional | — | — | `true` |

Exemplo:

```json
{
  "contractId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "numeroInscricaoSacado": "texto",
  "message": "texto",
  "installments": [
    {
      "id": "texto",
      "walletCode": 0,
      "description": "texto",
      "operations": [
        "texto"
      ],
      "admissionDates": [
        "2025-08-11T13:45:00Z"
      ],
      "payerName": "Fulano de Tal",
      "payerRegistrationNumber": "texto",
      "status": "texto",
      "statusDisplay": "texto",
      "billingCount": 0,
      "totalAmount": 0,
      "paidAmount": 1,
      "pendingAmount": 0,
      "overdueBillingsCount": 0,
      "paidBillingsCount": 1,
      "createdAt": "2025-08-11T13:45:00Z",
      "registered": true
    }
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |
| `404` | Recurso não encontrado. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/api/v1/Installment/ByContract/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /api/v1/Installment/{installmentId}/Register

**Método responsável por registrar um parcelamento específico** — Cria um novo registro de api.

Método responsável por registrar um parcelamento específico.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `installmentId` | path | `string` | obrigatório | indentificação | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Resposta 200**

Exemplo:

```json
true
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/Installment/3fa85f64-5717-4562-b3fc-2c963f66afa6/Register" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /api/v1/Installment/{installmentId}/Transfer

**Método utilizado para transferir um parcelamento especifico entre…** — Cria um novo registro de api.

Método utilizado para transferir um parcelamento especifico entre carteiras/convenios

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `installmentId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `toWalletCode` | `integer (int64)` | opcional | — | — | `0` |
| `toBillingSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `toCommunicationSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Exemplo:

```json
{
  "toWalletCode": 0,
  "toBillingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "toCommunicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

**Resposta 200**

Exemplo:

```json
"texto"
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/Installment/3fa85f64-5717-4562-b3fc-2c963f66afa6/Transfer" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "toWalletCode": 0,
  "toBillingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "toCommunicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
```

---

### POST /api/v1/Installment/{installmentId}/Cancel

**Método utilizado para cancelar um parcelamento especifico** — Cria um novo registro de api.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `installmentId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Resposta 200**

Exemplo:

```json
true
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/Installment/3fa85f64-5717-4562-b3fc-2c963f66afa6/Cancel" \
  -H "Authorization: Bearer {{token}}"
```

---

### PUT /api/v1/Installment/{installmentId}/UpdateCommunicationSetting

**Método utilizado para atualizar a régua de comunicação de um parcelamento…** — Atualiza por completo um registro de api existente.

Método utilizado para atualizar a régua de comunicação de um parcelamento especifico

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `installmentId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `communicationSettingId` | query | `string` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Resposta 200**

Exemplo:

```json
true
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/api/v1/Installment/3fa85f64-5717-4562-b3fc-2c963f66afa6/UpdateCommunicationSetting" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /api/v1/Installment/{installmentId}/DownloadPdf

**Método para download em PDF dos boletos de cobrança do parcelamento** — Lista e filtra registros de api.

Método para download em PDF dos boletos de cobrança do parcelamento.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `installmentId` | path | `string` | obrigatório | Identificador unico do parcelamento | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/api/v1/Installment/3fa85f64-5717-4562-b3fc-2c963f66afa6/DownloadPdf" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /api/v1/Installment/{installmentId}/SimulateEarlySettlement

**Método utilizado para simular uma liquidação antecipada** — Cria um novo registro de api.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `installmentId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `valuationDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `numberInstallments` | `integer` | opcional | — | — | `0` |
| `isSettleOutstandingBalance` | `boolean` | opcional | — | — | `true` |
| `billingSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Exemplo:

```json
{
  "valuationDate": "2025-08-11T13:45:00Z",
  "numberInstallments": 0,
  "isSettleOutstandingBalance": true,
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `totalAmount` | `integer (int64)` | opcional | — | — | `0` |
| `outstandingBalance` | `integer (int64)` | opcional | — | — | `0` |
| `outstandingBillings` | `integer` | opcional | — | — | `0` |
| `costAdvancePayment` | `integer (int64)` | opcional | — | — | `0` |
| `overdueBillings` | `integer` | opcional | — | — | `0` |
| `antecipatedBillings` | `integer` | opcional | — | — | `0` |
| `interestAmount` | `integer (int64)` | opcional | — | — | `0` |
| `fineAmount` | `integer (int64)` | opcional | — | — | `0` |
| `discountAmount` | `integer (int64)` | opcional | — | — | `0` |
| `overdueBillingsAmount` | `integer (int64)` | opcional | — | — | `0` |

Exemplo:

```json
{
  "totalAmount": 0,
  "outstandingBalance": 0,
  "outstandingBillings": 0,
  "costAdvancePayment": 0,
  "overdueBillings": 0,
  "antecipatedBillings": 0,
  "interestAmount": 0,
  "fineAmount": 0,
  "discountAmount": 0,
  "overdueBillingsAmount": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/Installment/3fa85f64-5717-4562-b3fc-2c963f66afa6/SimulateEarlySettlement" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "valuationDate": "2025-08-11T13:45:00Z",
  "numberInstallments": 0,
  "isSettleOutstandingBalance": true,
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
```

---

### POST /api/v1/Installment/{installmentId}/EarlyBilling

**Método de cadastro de uma cobrança de antecipação** — Cria um novo registro de api.

Método de cadastro de uma cobrança de antecipação.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `installmentId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |
| `valuationDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `numberInstallments` | `integer` | opcional | — | — | `0` |
| `isSettleOutstandingBalance` | `boolean` | opcional | — | — | `true` |
| `toBillingSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `toCommunicationSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Exemplo:

```json
{
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto",
  "valuationDate": "2025-08-11T13:45:00Z",
  "numberInstallments": 0,
  "isSettleOutstandingBalance": true,
  "toBillingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "toCommunicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

**Resposta 200**

Exemplo:

```json
true
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/Installment/3fa85f64-5717-4562-b3fc-2c963f66afa6/EarlyBilling" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto",
  "valuationDate": "2025-08-11T13:45:00Z",
  "numberInstallments": 0,
  "isSettleOutstandingBalance": true,
  "toBillingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "toCommunicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
```

---

### POST /api/v1/Installment/{installmentId}/SettleBillings

**Método para liquidar cobranças** — Cria um novo registro de api.

Método para liquidar cobranças.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `installmentId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `paymentValue` | `integer (int64)` | opcional | — | — | `0` |
| `paymentDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `applyDiscount` | `boolean` | opcional | — | — | `true` |
| `applyInterest` | `boolean` | opcional | — | — | `true` |
| `settlementChannel` | `string` | opcional | — | `Wallet`, `COB`, `STR`, `DebtCollection`, `Dataprev` | `"Wallet"` |

Exemplo:

```json
{
  "paymentValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "applyDiscount": true,
  "applyInterest": true,
  "settlementChannel": "Wallet"
}
```

**Resposta 200**

Exemplo:

```json
true
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/Installment/3fa85f64-5717-4562-b3fc-2c963f66afa6/SettleBillings" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "paymentValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "applyDiscount": true,
  "applyInterest": true,
  "settlementChannel": "Wallet"
}'
```

---