# Cobrança — Cobranças (UY3)

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

## Cobranças

Gerencie cobranças e seus dados ao longo do ciclo.

### GET /api/v1/Billing

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

Método de visualização da lista de cobranças.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `Registered` | query | `boolean` | opcional | — | `true` |
| `Amount` | query | `integer (int64)` | opcional | — | `10` |
| `DocumentNumber` | query | `string` | opcional | — | `valor` |
| `BarCode` | query | `string` | opcional | — | `valor` |
| `SearchString` | query | `string` | opcional | — | `valor` |
| `Tags` | query | `array de string` | opcional | — | `valor` |
| `StatusesValue` | query | `array de string` | opcional | — | `valor` |
| `ExcludeStatusesValue` | query | `array de string` | opcional | — | `valor` |
| `WalletsCode` | query | `array de integer (int64)` | opcional | — | `valor` |
| `DocumentsNumber` | query | `array de string` | opcional | — | `valor` |
| `BankSlipId` | query | `string` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `InstallmentId` | query | `string` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `CommunicationSettingId` | query | `string` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `BillingSettingId` | query | `string` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `InitialDueDate` | query | `string (date-time)` | opcional | — | `valor` |
| `FinalDueDate` | query | `string (date-time)` | opcional | — | `valor` |
| `InitialSettlementDate` | query | `string (date-time)` | opcional | — | `valor` |
| `FinalSettlementDate` | query | `string (date-time)` | opcional | — | `valor` |
| `InitialCreatedDate` | query | `string (date-time)` | opcional | — | `valor` |
| `FinalCreatedDate` | query | `string (date-time)` | opcional | — | `valor` |
| `PayerName` | query | `string` | opcional | — | `valor` |
| `Tenant` | query | `string` | opcional | — | `uy3` |
| `PayerRegistrationNumber` | query | `string` | opcional | — | `valor` |
| `FirstInstructionDebtCollection` | query | `string` | opcional | — | `valor` |
| `OurNumber` | query | `string` | opcional | — | `valor` |
| `ReferenceId` | query | `string` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `IsOrderByDueDate` | query | `boolean` | opcional | — | `true` |
| `Page` | query | `integer` | opcional | — | `10` |
| `Size` | query | `integer` | opcional | — | `10` |
| `BillingIds` | query | `array de string` | opcional | — | `valor` |

**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"` |
| `externalId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `walletCode` | `integer (int64)` | opcional | — | — | `0` |
| `documentNumber` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `paidAmount` | `integer (int64)` | opcional | — | — | `1` |
| `pendingAmount` | `integer (int64)` | opcional | — | — | `0` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `discount` | `integer` | opcional | — | — | `0` |
| `discountLimitDate` | `string` | opcional | — | — | `"texto"` |
| `discount2` | `integer` | opcional | — | — | `0` |
| `discountLimitDate2` | `string` | opcional | — | — | `"texto"` |
| `discount3` | `integer` | opcional | — | — | `0` |
| `discountLimitDate3` | `string` | opcional | — | — | `"texto"` |
| `dueDate` | `string` | opcional | — | — | `"texto"` |
| `billingSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `billingSettingDisplay` | `string` | opcional | — | — | `"texto"` |
| `communicationSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `communicationSettingDisplay` | `string` | opcional | — | — | `"texto"` |
| `tags` | `array de string` | opcional | — | — | `[ … ]` |
| `creditTypeValue` | `string` | opcional | — | — | `"texto"` |
| `creditTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `payer` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `guarantor` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `registered` | `boolean` | opcional | — | — | `true` |
| `errorMessage` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `settlementAt` | `string` | opcional | — | — | `"texto"` |
| `settlementChannelValue` | `string` | opcional | — | — | `"texto"` |
| `settlementChannelValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `statusValue` | `string` | opcional | — | — | `"texto"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `firstInstructionDebtCollection` | `string` | opcional | — | — | `"texto"` |
| `secondInstructionDebtCollection` | `integer` | opcional | — | — | `0` |
| `installmentId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankSlip` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `settings` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ourNumber` | `integer (int64)` | opcional | — | — | `0` |
| `ourNumberDigit` | `string` | opcional | — | — | `"texto"` |
| `walletNumber` | `integer` | opcional | — | — | `0` |
| `numberPayments` | `integer` | opcional | — | — | `0` |
| `deduction` | `integer` | opcional | — | — | `0` |
| `latePaymentInterestAmountPerDay` | `integer` | opcional | — | — | `0` |
| `conditionForIssuingBillingSlip` | `string` | opcional | — | — | `"texto"` |
| `zero` | `string` | opcional | — | — | `"texto"` |
| `directDebitAgency` | `string` | opcional | — | — | `"texto"` |
| `directDebitAgencyDigit` | `string` | opcional | — | — | `"texto"` |
| `directDebitAccount` | `string` | opcional | — | — | `"texto"` |
| `directDebitAccountDigit` | `string` | opcional | — | — | `"texto"` |
| `directDebitReason` | `string` | opcional | — | — | `"texto"` |
| `bonusDiscountDay` | `string` | opcional | — | — | `"texto"` |
| `addressingAutomaticDebitNotification` | `string` | opcional | — | — | `"texto"` |
| `identificationBillingSlipIssuance` | `string` | opcional | — | — | `"texto"` |
| `acceptanceIdentification` | `string` | opcional | — | — | `"01310930"` |
| `depositoryAgency` | `string` | opcional | — | — | `"texto"` |
| `billingBankCharge` | `string` | opcional | — | — | `"texto"` |
| `bankCode` | `string` | opcional | — | — | `"texto"` |
| `iof` | `string` | opcional | — | — | `"texto"` |
| `bankingOperationIdentification` | `string` | opcional | — | — | `"texto"` |
| `creditDistributionIdentification` | `string` | opcional | — | — | `"texto"` |
| `participantControlNumber` | `string` | opcional | — | — | `"texto"` |
| `generateInstructionTransactionLine` | `boolean` | opcional | — | — | `true` |
| `captureType` | `string` | opcional | — | — | `"texto"` |
| `captureTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `paymentMethod` | `string` | opcional | — | — | `"texto"` |
| `paymentMethodDisplay` | `string` | opcional | — | — | `"texto"` |
| `billingCreateType` | `string` | opcional | — | — | `"texto"` |
| `billingCreateTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `lastPaymentDate` | `string` | opcional | — | — | `"texto"` |
| `payments` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `fileInstructionLines` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `fileConfirmationLines` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `isAnticipatedBilling` | `boolean` | opcional | — | — | `true` |

Detalhe de `payments`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `settlementChannelValue` | `string` | opcional | — | — | `"texto"` |
| `settlementChannelValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `paymentDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `paymentAmount` | `integer (int64)` | opcional | — | — | `0` |
| `paymentISPB` | `integer` | opcional | — | — | `0` |
| `paymentAgency` | `integer` | opcional | — | — | `0` |
| `debtCollectionProtocol` | `string` | opcional | — | — | `"texto"` |

Detalhe de `fileInstructionLines`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `walletCode` | `integer (int64)` | opcional | — | — | `0` |
| `lineType` | `string` | opcional | — | — | `"texto"` |
| `lineTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `sequentialNumber` | `integer` | opcional | — | — | `0` |
| `detail` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Detalhe de `fileConfirmationLines`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `lineType` | `string` | opcional | — | — | `"texto"` |
| `lineTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `sequentialNumber` | `integer` | opcional | — | — | `0` |
| `detail` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Exemplo:

```json
{
  "data": [
    {
      "id": "texto",
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "walletCode": 0,
      "documentNumber": "texto",
      "amount": 0,
      "paidAmount": 1,
      "pendingAmount": 0,
      "description": "texto",
      "discount": 0,
      "discountLimitDate": "texto",
      "discount2": 0,
      "discountLimitDate2": "texto",
      "discount3": 0,
      "discountLimitDate3": "texto",
      "dueDate": "texto",
      "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "billingSettingDisplay": "texto",
      "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "communicationSettingDisplay": "texto",
      "tags": [
        "texto"
      ],
      "creditTypeValue": "texto",
      "creditTypeDisplay": "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"
      },
      "registered": true,
      "errorMessage": "texto",
      "createdAt": "2025-08-11T13:45:00Z",
      "settlementAt": "texto",
      "settlementChannelValue": "texto",
      "settlementChannelValueDisplay": "texto",
      "statusValue": "texto",
      "statusDisplay": "texto",
      "firstInstructionDebtCollection": "texto",
      "secondInstructionDebtCollection": 0,
      "installmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "bankSlip": {
        "id": "texto",
        "barCode": "texto",
        "statusRegisterValue": "texto",
        "statusRegisterValueDisplay": "texto",
        "statusSettlementValue": "texto",
        "statusSettlementValueDisplay": "texto",
        "statusDebtCollectionValue": "texto",
        "statusDebtCollectionValueDisplay": "texto"
      },
      "settings": {
        "interestTypeValue": "texto",
        "interestTypeValueDisplay": "texto",
        "interestAmount": 1000,
        "fineTypeValue": "texto",
        "fineTypeValueDisplay": "texto",
        "fineAmount": 1000
      },
      "ourNumber": 0,
      "ourNumberDigit": "texto",
      "walletNumber": 0,
      "numberPayments": 0,
      "deduction": 0,
      "latePaymentInterestAmountPerDay": 0,
      "conditionForIssuingBillingSlip": "texto",
      "zero": "texto",
      "directDebitAgency": "texto",
      "directDebitAgencyDigit": "texto",
      "directDebitAccount": "texto",
      "directDebitAccountDigit": "texto",
      "directDebitReason": "texto",
      "bonusDiscountDay": "texto",
      "addressingAutomaticDebitNotification": "texto",
      "identificationBillingSlipIssuance": "texto",
      "acceptanceIdentification": "01310930",
      "depositoryAgency": "texto",
      "billingBankCharge": "texto",
      "bankCode": "texto",
      "iof": "texto",
      "bankingOperationIdentification": "texto",
      "creditDistributionIdentification": "texto",
      "participantControlNumber": "texto",
      "generateInstructionTransactionLine": true,
      "captureType": "texto",
      "captureTypeDisplay": "texto",
      "paymentMethod": "texto",
      "paymentMethodDisplay": "texto",
      "billingCreateType": "texto",
      "billingCreateTypeDisplay": "texto",
      "lastPaymentDate": "texto",
      "payments": [
        {}
      ],
      "fileInstructionLines": [
        {}
      ],
      "fileConfirmationLines": [
        {}
      ],
      "isAnticipatedBilling": true
    }
  ],
  "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/Billing" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /api/v1/Billing

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

Método de cadastro de uma cobrança.

**Parâmetros**

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

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `externalId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `walletCode` | `integer (int64)` | opcional | — | — | `0` |
| `documentNumber` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `dueDate` | `string` | opcional | — | — | `"texto"` |
| `paymentLimitDate` | `string` | opcional | — | — | `"texto"` |
| `discount` | `integer` | opcional | — | — | `0` |
| `discountLimitDate` | `string` | opcional | — | — | `"texto"` |
| `discount2` | `integer` | opcional | — | — | `0` |
| `discountLimitDate2` | `string` | opcional | — | — | `"texto"` |
| `discount3` | `integer` | opcional | — | — | `0` |
| `discountLimitDate3` | `string` | opcional | — | — | `"texto"` |
| `billingSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `communicationSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `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` |
| `installmentId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `settings` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ourNumber` | `integer (int64)` | opcional | — | — | `0` |
| `ourNumberDigit` | `string` | opcional | — | — | `"texto"` |
| `walletNumber` | `integer` | opcional | — | — | `0` |
| `numberPayments` | `integer` | opcional | — | — | `0` |
| `deduction` | `integer` | opcional | — | — | `0` |
| `latePaymentInterestAmountPerDay` | `integer` | opcional | — | — | `0` |
| `creditTypeValue` | `string` | opcional | — | — | `"texto"` |
| `conditionForIssuingBillingSlip` | `string` | opcional | — | — | `"texto"` |
| `directDebitAgency` | `string` | opcional | — | — | `"texto"` |
| `directDebitAgencyDigit` | `string` | opcional | — | — | `"texto"` |
| `directDebitAccount` | `string` | opcional | — | — | `"texto"` |
| `directDebitAccountDigit` | `string` | opcional | — | — | `"texto"` |
| `directDebitReason` | `string` | opcional | — | — | `"texto"` |
| `bonusDiscountDay` | `string` | opcional | — | — | `"texto"` |
| `addressingAutomaticDebitNotification` | `string` | opcional | — | — | `"texto"` |
| `identificationBillingSlipIssuance` | `string` | opcional | — | — | `"texto"` |
| `acceptanceIdentification` | `string` | opcional | — | — | `"01310930"` |
| `depositoryAgency` | `string` | opcional | — | — | `"texto"` |
| `billingBankCharge` | `string` | opcional | — | — | `"texto"` |
| `bankCode` | `string` | opcional | — | — | `"texto"` |
| `iof` | `string` | opcional | — | — | `"texto"` |
| `bankingOperationIdentification` | `string` | opcional | — | — | `"texto"` |
| `creditDistributionIdentification` | `string` | opcional | — | — | `"texto"` |
| `participantControlNumber` | `string` | opcional | — | — | `"texto"` |
| `register` | `boolean` | opcional | — | — | `true` |
| `billingCreateTypeValue` | `string` | opcional | — | — | `"texto"` |
| `billingsToCancel` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `billingsToUnified` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `billingsToCancel`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `billingStatusValue` | `string` | opcional | — | — | `"texto"` |

Detalhe de `billingsToUnified`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `interestCodeValue` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "walletCode": 0,
  "documentNumber": "texto",
  "amount": 0,
  "description": "texto",
  "dueDate": "texto",
  "paymentLimitDate": "texto",
  "discount": 0,
  "discountLimitDate": "texto",
  "discount2": 0,
  "discountLimitDate2": "texto",
  "discount3": 0,
  "discountLimitDate3": "texto",
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tags": [
    "texto"
  ],
  "payer": {
    "name": "Fulano de Tal",
    "personTypeValue": "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,
  "installmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "settings": {
    "interestTypeValue": "texto",
    "interestAmount": 1000,
    "fineTypeValue": "texto",
    "fineAmount": 1000,
    "interestCodeValue": "texto"
  },
  "ourNumber": 0,
  "ourNumberDigit": "texto",
  "walletNumber": 0,
  "numberPayments": 0,
  "deduction": 0,
  "latePaymentInterestAmountPerDay": 0,
  "creditTypeValue": "texto",
  "conditionForIssuingBillingSlip": "texto",
  "directDebitAgency": "texto",
  "directDebitAgencyDigit": "texto",
  "directDebitAccount": "texto",
  "directDebitAccountDigit": "texto",
  "directDebitReason": "texto",
  "bonusDiscountDay": "texto",
  "addressingAutomaticDebitNotification": "texto",
  "identificationBillingSlipIssuance": "texto",
  "acceptanceIdentification": "01310930",
  "depositoryAgency": "texto",
  "billingBankCharge": "texto",
  "bankCode": "texto",
  "iof": "texto",
  "bankingOperationIdentification": "texto",
  "creditDistributionIdentification": "texto",
  "participantControlNumber": "texto",
  "register": true,
  "billingCreateTypeValue": "texto",
  "billingsToCancel": [
    {
      "id": "texto",
      "billingStatusValue": "texto"
    }
  ],
  "billingsToUnified": [
    {
      "id": "texto",
      "interestCodeValue": "texto"
    }
  ]
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `externalId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `walletCode` | `integer (int64)` | opcional | — | — | `0` |
| `documentNumber` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `paidAmount` | `integer (int64)` | opcional | — | — | `1` |
| `pendingAmount` | `integer (int64)` | opcional | — | — | `0` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `discount` | `integer` | opcional | — | — | `0` |
| `discountLimitDate` | `string` | opcional | — | — | `"texto"` |
| `discount2` | `integer` | opcional | — | — | `0` |
| `discountLimitDate2` | `string` | opcional | — | — | `"texto"` |
| `discount3` | `integer` | opcional | — | — | `0` |
| `discountLimitDate3` | `string` | opcional | — | — | `"texto"` |
| `dueDate` | `string` | opcional | — | — | `"texto"` |
| `billingSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `billingSettingDisplay` | `string` | opcional | — | — | `"texto"` |
| `communicationSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `communicationSettingDisplay` | `string` | opcional | — | — | `"texto"` |
| `tags` | `array de string` | opcional | — | — | `[ … ]` |
| `creditTypeValue` | `string` | opcional | — | — | `"texto"` |
| `creditTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `payer` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `guarantor` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `registered` | `boolean` | opcional | — | — | `true` |
| `errorMessage` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `settlementAt` | `string` | opcional | — | — | `"texto"` |
| `settlementChannelValue` | `string` | opcional | — | — | `"texto"` |
| `settlementChannelValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `statusValue` | `string` | opcional | — | — | `"texto"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `firstInstructionDebtCollection` | `string` | opcional | — | — | `"texto"` |
| `secondInstructionDebtCollection` | `integer` | opcional | — | — | `0` |
| `installmentId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankSlip` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `settings` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ourNumber` | `integer (int64)` | opcional | — | — | `0` |
| `ourNumberDigit` | `string` | opcional | — | — | `"texto"` |
| `walletNumber` | `integer` | opcional | — | — | `0` |
| `numberPayments` | `integer` | opcional | — | — | `0` |
| `deduction` | `integer` | opcional | — | — | `0` |
| `latePaymentInterestAmountPerDay` | `integer` | opcional | — | — | `0` |
| `conditionForIssuingBillingSlip` | `string` | opcional | — | — | `"texto"` |
| `zero` | `string` | opcional | — | — | `"texto"` |
| `directDebitAgency` | `string` | opcional | — | — | `"texto"` |
| `directDebitAgencyDigit` | `string` | opcional | — | — | `"texto"` |
| `directDebitAccount` | `string` | opcional | — | — | `"texto"` |
| `directDebitAccountDigit` | `string` | opcional | — | — | `"texto"` |
| `directDebitReason` | `string` | opcional | — | — | `"texto"` |
| `bonusDiscountDay` | `string` | opcional | — | — | `"texto"` |
| `addressingAutomaticDebitNotification` | `string` | opcional | — | — | `"texto"` |
| `identificationBillingSlipIssuance` | `string` | opcional | — | — | `"texto"` |
| `acceptanceIdentification` | `string` | opcional | — | — | `"01310930"` |
| `depositoryAgency` | `string` | opcional | — | — | `"texto"` |
| `billingBankCharge` | `string` | opcional | — | — | `"texto"` |
| `bankCode` | `string` | opcional | — | — | `"texto"` |
| `iof` | `string` | opcional | — | — | `"texto"` |
| `bankingOperationIdentification` | `string` | opcional | — | — | `"texto"` |
| `creditDistributionIdentification` | `string` | opcional | — | — | `"texto"` |
| `participantControlNumber` | `string` | opcional | — | — | `"texto"` |
| `generateInstructionTransactionLine` | `boolean` | opcional | — | — | `true` |
| `captureType` | `string` | opcional | — | — | `"texto"` |
| `captureTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `paymentMethod` | `string` | opcional | — | — | `"texto"` |
| `paymentMethodDisplay` | `string` | opcional | — | — | `"texto"` |
| `billingCreateType` | `string` | opcional | — | — | `"texto"` |
| `billingCreateTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `lastPaymentDate` | `string` | opcional | — | — | `"texto"` |
| `payments` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `fileInstructionLines` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `fileConfirmationLines` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `isAnticipatedBilling` | `boolean` | opcional | — | — | `true` |

Detalhe de `payments`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `settlementChannelValue` | `string` | opcional | — | — | `"texto"` |
| `settlementChannelValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `paymentDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `paymentAmount` | `integer (int64)` | opcional | — | — | `0` |
| `paymentISPB` | `integer` | opcional | — | — | `0` |
| `paymentAgency` | `integer` | opcional | — | — | `0` |
| `debtCollectionProtocol` | `string` | opcional | — | — | `"texto"` |

Detalhe de `fileInstructionLines`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `walletCode` | `integer (int64)` | opcional | — | — | `0` |
| `lineType` | `string` | opcional | — | — | `"texto"` |
| `lineTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `sequentialNumber` | `integer` | opcional | — | — | `0` |
| `detail` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Detalhe de `fileConfirmationLines`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `lineType` | `string` | opcional | — | — | `"texto"` |
| `lineTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `sequentialNumber` | `integer` | opcional | — | — | `0` |
| `detail` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Exemplo:

```json
{
  "id": "texto",
  "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "walletCode": 0,
  "documentNumber": "texto",
  "amount": 0,
  "paidAmount": 1,
  "pendingAmount": 0,
  "description": "texto",
  "discount": 0,
  "discountLimitDate": "texto",
  "discount2": 0,
  "discountLimitDate2": "texto",
  "discount3": 0,
  "discountLimitDate3": "texto",
  "dueDate": "texto",
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "billingSettingDisplay": "texto",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingDisplay": "texto",
  "tags": [
    "texto"
  ],
  "creditTypeValue": "texto",
  "creditTypeDisplay": "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"
  },
  "registered": true,
  "errorMessage": "texto",
  "createdAt": "2025-08-11T13:45:00Z",
  "settlementAt": "texto",
  "settlementChannelValue": "texto",
  "settlementChannelValueDisplay": "texto",
  "statusValue": "texto",
  "statusDisplay": "texto",
  "firstInstructionDebtCollection": "texto",
  "secondInstructionDebtCollection": 0,
  "installmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankSlip": {
    "id": "texto",
    "barCode": "texto",
    "statusRegisterValue": "texto",
    "statusRegisterValueDisplay": "texto",
    "statusSettlementValue": "texto",
    "statusSettlementValueDisplay": "texto",
    "statusDebtCollectionValue": "texto",
    "statusDebtCollectionValueDisplay": "texto"
  },
  "settings": {
    "interestTypeValue": "texto",
    "interestTypeValueDisplay": "texto",
    "interestAmount": 1000,
    "fineTypeValue": "texto",
    "fineTypeValueDisplay": "texto",
    "fineAmount": 1000
  },
  "ourNumber": 0,
  "ourNumberDigit": "texto",
  "walletNumber": 0,
  "numberPayments": 0,
  "deduction": 0,
  "latePaymentInterestAmountPerDay": 0,
  "conditionForIssuingBillingSlip": "texto",
  "zero": "texto",
  "directDebitAgency": "texto",
  "directDebitAgencyDigit": "texto",
  "directDebitAccount": "texto",
  "directDebitAccountDigit": "texto",
  "directDebitReason": "texto",
  "bonusDiscountDay": "texto",
  "addressingAutomaticDebitNotification": "texto",
  "identificationBillingSlipIssuance": "texto",
  "acceptanceIdentification": "01310930",
  "depositoryAgency": "texto",
  "billingBankCharge": "texto",
  "bankCode": "texto",
  "iof": "texto",
  "bankingOperationIdentification": "texto",
  "creditDistributionIdentification": "texto",
  "participantControlNumber": "texto",
  "generateInstructionTransactionLine": true,
  "captureType": "texto",
  "captureTypeDisplay": "texto",
  "paymentMethod": "texto",
  "paymentMethodDisplay": "texto",
  "billingCreateType": "texto",
  "billingCreateTypeDisplay": "texto",
  "lastPaymentDate": "texto",
  "payments": [
    {
      "settlementChannelValue": "texto",
      "settlementChannelValueDisplay": "texto",
      "paymentDate": "2025-08-11T13:45:00Z",
      "paymentAmount": 0,
      "paymentISPB": 0,
      "paymentAgency": 0,
      "debtCollectionProtocol": "texto"
    }
  ],
  "fileInstructionLines": [
    {
      "id": "texto",
      "walletCode": 0,
      "lineType": "texto",
      "lineTypeDisplay": "texto",
      "sequentialNumber": 0,
      "detail": {
        "bankSlipId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "uniqueIdentifierCip": "texto",
        "barCode": "texto",
        "numericLine": "texto",
        "confirmationTransactionTypeValue": "texto",
        "confirmationTransactionTypeValueDisplay": "texto",
        "documentNumber": "texto",
        "deduction": 0,
        "discount": 0,
        "walletNumber": 0,
        "account": "texto",
        "participantControlNumber": "texto",
        "payerName": "Fulano de Tal",
        "amount": 0,
        "ourNumber": 0,
        "ourNumberDigit": "texto",
        "dueDate": "texto",
        "fineTypeValue": "texto",
        "fineTypeValueDisplay": "texto",
        "fineDecimal": 1000,
        "interestAmountLateDay": 1000,
        "statusOperationValue": "texto",
        "statusOperationValueDisplay": "texto",
        "error": "texto",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "updatedBy": {}
      }
    }
  ],
  "fileConfirmationLines": [
    {
      "id": "texto",
      "lineType": "texto",
      "lineTypeDisplay": "texto",
      "sequentialNumber": 0,
      "detail": {
        "bankSlipId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "billingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "amount": 0,
        "occurrenceDate": "2025-08-11T13:45:00Z",
        "occurrenceCode": "texto",
        "occurrenceReason": "texto",
        "confirmationTransactionTypeValue": "texto",
        "confirmationTransactionTypeValueDisplay": "texto",
        "documentNumber": "texto",
        "deduction": 0,
        "discount": 0,
        "ourNumber": "texto",
        "walletNumber": "texto",
        "payerName": "Fulano de Tal",
        "participantControlNumber": "texto",
        "ourNumberDigit": "texto",
        "dueDate": "texto",
        "interestAmount": 0,
        "paid": 1,
        "paidCreditDay": "2025-08-11T13:45:00Z",
        "costs": 0,
        "statusLiquidation": "texto",
        "statusLiquidationDisplay": "texto",
        "debtCollectionDate": "texto",
        "debtCollectionRegistryNumber": "texto",
        "debtCollectionProtocolNumber": "texto",
        "debtCollectionName": "Fulano de Tal",
        "debtCollectionCity": "texto",
        "debtCollectionState": "texto",
        "debtCollectionOffice": "texto",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "updatedBy": {}
      }
    }
  ],
  "isAnticipatedBilling": 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/Billing" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "walletCode": 0,
  "documentNumber": "texto",
  "amount": 0,
  "description": "texto",
  "dueDate": "texto",
  "paymentLimitDate": "texto",
  "discount": 0,
  "discountLimitDate": "texto",
  "discount2": 0,
  "discountLimitDate2": "texto",
  "discount3": 0,
  "discountLimitDate3": "texto",
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tags": [
    "texto"
  ],
  "payer": {
    "name": "Fulano de Tal",
    "personTypeValue": "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,
  "installmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "settings": {
    "interestTypeValue": "texto",
    "interestAmount": 1000,
    "fineTypeValue": "texto",
    "fineAmount": 1000,
    "interestCodeValue": "texto"
  },
  "ourNumber": 0,
  "ourNumberDigit": "texto",
  "walletNumber": 0,
  "numberPayments": 0,
  "deduction": 0,
  "latePaymentInterestAmountPerDay": 0,
  "creditTypeValue": "texto",
  "conditionForIssuingBillingSlip": "texto",
  "directDebitAgency": "texto",
  "directDebitAgencyDigit": "texto",
  "directDebitAccount": "texto",
  "directDebitAccountDigit": "texto",
  "directDebitReason": "texto",
  "bonusDiscountDay": "texto",
  "addressingAutomaticDebitNotification": "texto",
  "identificationBillingSlipIssuance": "texto",
  "acceptanceIdentification": "01310930",
  "depositoryAgency": "texto",
  "billingBankCharge": "texto",
  "bankCode": "texto",
  "iof": "texto",
  "bankingOperationIdentification": "texto",
  "creditDistributionIdentification": "texto",
  "participantControlNumber": "texto",
  "register": true,
  "billingCreateTypeValue": "texto",
  "billingsToCancel": [
    {
      "id": "texto",
      "billingStatusValue": "texto"
    }
  ],
  "billingsToUnified": [
    {
      "id": "texto",
      "interestCodeValue": "texto"
    }
  ]
}'
```

---

### GET /api/v1/Billing/Export

**Método responsável por exportar visualização da lista de cobranças** — Lista e filtra registros de api.

Método responsável por exportar visualização da lista de cobranças.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `Registered` | query | `boolean` | opcional | — | `true` |
| `Amount` | query | `integer (int64)` | opcional | — | `10` |
| `DocumentNumber` | query | `string` | opcional | — | `valor` |
| `BarCode` | query | `string` | opcional | — | `valor` |
| `SearchString` | query | `string` | opcional | — | `valor` |
| `Tags` | query | `array de string` | opcional | — | `valor` |
| `StatusesValue` | query | `array de string` | opcional | — | `valor` |
| `ExcludeStatusesValue` | query | `array de string` | opcional | — | `valor` |
| `WalletsCode` | query | `array de integer (int64)` | opcional | — | `valor` |
| `BankSlipId` | query | `string` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `InitialDueDate` | query | `string (date-time)` | opcional | — | `valor` |
| `FinalDueDate` | query | `string (date-time)` | opcional | — | `valor` |
| `InitialSettlementDate` | query | `string (date-time)` | opcional | — | `valor` |
| `FinalSettlementDate` | query | `string (date-time)` | opcional | — | `valor` |
| `PayerName` | query | `string` | opcional | — | `valor` |
| `Tenant` | query | `string` | opcional | — | `uy3` |
| `PayerRegistrationNumber` | query | `string` | opcional | — | `valor` |
| `FirstInstructionDebtCollection` | query | `string` | opcional | — | `valor` |
| `BillingIds` | query | `array de string` | opcional | — | `valor` |

**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/Billing/Export" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /api/v1/Billing/{referenceId}

**Método de visualização de uma cobrança específica** — Consulta api pelo identificador informado na rota.

Método de visualização de uma cobrança específica.

**Parâmetros**

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

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `externalId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `walletCode` | `integer (int64)` | opcional | — | — | `0` |
| `documentNumber` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `paidAmount` | `integer (int64)` | opcional | — | — | `1` |
| `pendingAmount` | `integer (int64)` | opcional | — | — | `0` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `discount` | `integer` | opcional | — | — | `0` |
| `discountLimitDate` | `string` | opcional | — | — | `"texto"` |
| `discount2` | `integer` | opcional | — | — | `0` |
| `discountLimitDate2` | `string` | opcional | — | — | `"texto"` |
| `discount3` | `integer` | opcional | — | — | `0` |
| `discountLimitDate3` | `string` | opcional | — | — | `"texto"` |
| `dueDate` | `string` | opcional | — | — | `"texto"` |
| `billingSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `billingSettingDisplay` | `string` | opcional | — | — | `"texto"` |
| `communicationSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `communicationSettingDisplay` | `string` | opcional | — | — | `"texto"` |
| `tags` | `array de string` | opcional | — | — | `[ … ]` |
| `creditTypeValue` | `string` | opcional | — | — | `"texto"` |
| `creditTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `payer` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `guarantor` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `registered` | `boolean` | opcional | — | — | `true` |
| `errorMessage` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `settlementAt` | `string` | opcional | — | — | `"texto"` |
| `settlementChannelValue` | `string` | opcional | — | — | `"texto"` |
| `settlementChannelValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `statusValue` | `string` | opcional | — | — | `"texto"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `firstInstructionDebtCollection` | `string` | opcional | — | — | `"texto"` |
| `secondInstructionDebtCollection` | `integer` | opcional | — | — | `0` |
| `installmentId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankSlip` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `settings` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ourNumber` | `integer (int64)` | opcional | — | — | `0` |
| `ourNumberDigit` | `string` | opcional | — | — | `"texto"` |
| `walletNumber` | `integer` | opcional | — | — | `0` |
| `numberPayments` | `integer` | opcional | — | — | `0` |
| `deduction` | `integer` | opcional | — | — | `0` |
| `latePaymentInterestAmountPerDay` | `integer` | opcional | — | — | `0` |
| `conditionForIssuingBillingSlip` | `string` | opcional | — | — | `"texto"` |
| `zero` | `string` | opcional | — | — | `"texto"` |
| `directDebitAgency` | `string` | opcional | — | — | `"texto"` |
| `directDebitAgencyDigit` | `string` | opcional | — | — | `"texto"` |
| `directDebitAccount` | `string` | opcional | — | — | `"texto"` |
| `directDebitAccountDigit` | `string` | opcional | — | — | `"texto"` |
| `directDebitReason` | `string` | opcional | — | — | `"texto"` |
| `bonusDiscountDay` | `string` | opcional | — | — | `"texto"` |
| `addressingAutomaticDebitNotification` | `string` | opcional | — | — | `"texto"` |
| `identificationBillingSlipIssuance` | `string` | opcional | — | — | `"texto"` |
| `acceptanceIdentification` | `string` | opcional | — | — | `"01310930"` |
| `depositoryAgency` | `string` | opcional | — | — | `"texto"` |
| `billingBankCharge` | `string` | opcional | — | — | `"texto"` |
| `bankCode` | `string` | opcional | — | — | `"texto"` |
| `iof` | `string` | opcional | — | — | `"texto"` |
| `bankingOperationIdentification` | `string` | opcional | — | — | `"texto"` |
| `creditDistributionIdentification` | `string` | opcional | — | — | `"texto"` |
| `participantControlNumber` | `string` | opcional | — | — | `"texto"` |
| `generateInstructionTransactionLine` | `boolean` | opcional | — | — | `true` |
| `captureType` | `string` | opcional | — | — | `"texto"` |
| `captureTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `paymentMethod` | `string` | opcional | — | — | `"texto"` |
| `paymentMethodDisplay` | `string` | opcional | — | — | `"texto"` |
| `billingCreateType` | `string` | opcional | — | — | `"texto"` |
| `billingCreateTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `lastPaymentDate` | `string` | opcional | — | — | `"texto"` |
| `payments` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `fileInstructionLines` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `fileConfirmationLines` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `isAnticipatedBilling` | `boolean` | opcional | — | — | `true` |

Detalhe de `payments`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `settlementChannelValue` | `string` | opcional | — | — | `"texto"` |
| `settlementChannelValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `paymentDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `paymentAmount` | `integer (int64)` | opcional | — | — | `0` |
| `paymentISPB` | `integer` | opcional | — | — | `0` |
| `paymentAgency` | `integer` | opcional | — | — | `0` |
| `debtCollectionProtocol` | `string` | opcional | — | — | `"texto"` |

Detalhe de `fileInstructionLines`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `walletCode` | `integer (int64)` | opcional | — | — | `0` |
| `lineType` | `string` | opcional | — | — | `"texto"` |
| `lineTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `sequentialNumber` | `integer` | opcional | — | — | `0` |
| `detail` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Detalhe de `fileConfirmationLines`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `lineType` | `string` | opcional | — | — | `"texto"` |
| `lineTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `sequentialNumber` | `integer` | opcional | — | — | `0` |
| `detail` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Exemplo:

```json
{
  "id": "texto",
  "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "walletCode": 0,
  "documentNumber": "texto",
  "amount": 0,
  "paidAmount": 1,
  "pendingAmount": 0,
  "description": "texto",
  "discount": 0,
  "discountLimitDate": "texto",
  "discount2": 0,
  "discountLimitDate2": "texto",
  "discount3": 0,
  "discountLimitDate3": "texto",
  "dueDate": "texto",
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "billingSettingDisplay": "texto",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingDisplay": "texto",
  "tags": [
    "texto"
  ],
  "creditTypeValue": "texto",
  "creditTypeDisplay": "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"
  },
  "registered": true,
  "errorMessage": "texto",
  "createdAt": "2025-08-11T13:45:00Z",
  "settlementAt": "texto",
  "settlementChannelValue": "texto",
  "settlementChannelValueDisplay": "texto",
  "statusValue": "texto",
  "statusDisplay": "texto",
  "firstInstructionDebtCollection": "texto",
  "secondInstructionDebtCollection": 0,
  "installmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankSlip": {
    "id": "texto",
    "barCode": "texto",
    "statusRegisterValue": "texto",
    "statusRegisterValueDisplay": "texto",
    "statusSettlementValue": "texto",
    "statusSettlementValueDisplay": "texto",
    "statusDebtCollectionValue": "texto",
    "statusDebtCollectionValueDisplay": "texto"
  },
  "settings": {
    "interestTypeValue": "texto",
    "interestTypeValueDisplay": "texto",
    "interestAmount": 1000,
    "fineTypeValue": "texto",
    "fineTypeValueDisplay": "texto",
    "fineAmount": 1000
  },
  "ourNumber": 0,
  "ourNumberDigit": "texto",
  "walletNumber": 0,
  "numberPayments": 0,
  "deduction": 0,
  "latePaymentInterestAmountPerDay": 0,
  "conditionForIssuingBillingSlip": "texto",
  "zero": "texto",
  "directDebitAgency": "texto",
  "directDebitAgencyDigit": "texto",
  "directDebitAccount": "texto",
  "directDebitAccountDigit": "texto",
  "directDebitReason": "texto",
  "bonusDiscountDay": "texto",
  "addressingAutomaticDebitNotification": "texto",
  "identificationBillingSlipIssuance": "texto",
  "acceptanceIdentification": "01310930",
  "depositoryAgency": "texto",
  "billingBankCharge": "texto",
  "bankCode": "texto",
  "iof": "texto",
  "bankingOperationIdentification": "texto",
  "creditDistributionIdentification": "texto",
  "participantControlNumber": "texto",
  "generateInstructionTransactionLine": true,
  "captureType": "texto",
  "captureTypeDisplay": "texto",
  "paymentMethod": "texto",
  "paymentMethodDisplay": "texto",
  "billingCreateType": "texto",
  "billingCreateTypeDisplay": "texto",
  "lastPaymentDate": "texto",
  "payments": [
    {
      "settlementChannelValue": "texto",
      "settlementChannelValueDisplay": "texto",
      "paymentDate": "2025-08-11T13:45:00Z",
      "paymentAmount": 0,
      "paymentISPB": 0,
      "paymentAgency": 0,
      "debtCollectionProtocol": "texto"
    }
  ],
  "fileInstructionLines": [
    {
      "id": "texto",
      "walletCode": 0,
      "lineType": "texto",
      "lineTypeDisplay": "texto",
      "sequentialNumber": 0,
      "detail": {
        "bankSlipId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "uniqueIdentifierCip": "texto",
        "barCode": "texto",
        "numericLine": "texto",
        "confirmationTransactionTypeValue": "texto",
        "confirmationTransactionTypeValueDisplay": "texto",
        "documentNumber": "texto",
        "deduction": 0,
        "discount": 0,
        "walletNumber": 0,
        "account": "texto",
        "participantControlNumber": "texto",
        "payerName": "Fulano de Tal",
        "amount": 0,
        "ourNumber": 0,
        "ourNumberDigit": "texto",
        "dueDate": "texto",
        "fineTypeValue": "texto",
        "fineTypeValueDisplay": "texto",
        "fineDecimal": 1000,
        "interestAmountLateDay": 1000,
        "statusOperationValue": "texto",
        "statusOperationValueDisplay": "texto",
        "error": "texto",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "updatedBy": {}
      }
    }
  ],
  "fileConfirmationLines": [
    {
      "id": "texto",
      "lineType": "texto",
      "lineTypeDisplay": "texto",
      "sequentialNumber": 0,
      "detail": {
        "bankSlipId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "billingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "amount": 0,
        "occurrenceDate": "2025-08-11T13:45:00Z",
        "occurrenceCode": "texto",
        "occurrenceReason": "texto",
        "confirmationTransactionTypeValue": "texto",
        "confirmationTransactionTypeValueDisplay": "texto",
        "documentNumber": "texto",
        "deduction": 0,
        "discount": 0,
        "ourNumber": "texto",
        "walletNumber": "texto",
        "payerName": "Fulano de Tal",
        "participantControlNumber": "texto",
        "ourNumberDigit": "texto",
        "dueDate": "texto",
        "interestAmount": 0,
        "paid": 1,
        "paidCreditDay": "2025-08-11T13:45:00Z",
        "costs": 0,
        "statusLiquidation": "texto",
        "statusLiquidationDisplay": "texto",
        "debtCollectionDate": "texto",
        "debtCollectionRegistryNumber": "texto",
        "debtCollectionProtocolNumber": "texto",
        "debtCollectionName": "Fulano de Tal",
        "debtCollectionCity": "texto",
        "debtCollectionState": "texto",
        "debtCollectionOffice": "texto",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "updatedBy": {}
      }
    }
  ],
  "isAnticipatedBilling": 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/Billing/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### PATCH /api/v1/Billing/{referenceId}

**Método de atualização de uma cobrança específica** — Atualiza parcialmente um registro de api.

Método de atualização de uma cobrança específica.

**Parâmetros**

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

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `documentNumber` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `dueDate` | `string` | opcional | — | — | `"texto"` |
| `discount` | `integer` | opcional | — | — | `0` |
| `discountLimitDate` | `string` | opcional | — | — | `"texto"` |
| `discount2` | `integer` | opcional | — | — | `0` |
| `discountLimitDate2` | `string` | opcional | — | — | `"texto"` |
| `discount3` | `integer` | opcional | — | — | `0` |
| `discountLimitDate3` | `string` | opcional | — | — | `"texto"` |
| `billingSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `communicationSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `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` |
| `settings` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ourNumber` | `integer (int64)` | opcional | — | — | `0` |
| `ourNumberDigit` | `string` | opcional | — | — | `"texto"` |
| `walletNumber` | `integer` | opcional | — | — | `0` |
| `numberPayments` | `integer` | opcional | — | — | `0` |
| `deduction` | `integer` | opcional | — | — | `0` |
| `latePaymentInterestAmountPerDay` | `integer` | opcional | — | — | `0` |
| `creditTypeValue` | `string` | opcional | — | — | `"texto"` |
| `conditionForIssuingBillingSlip` | `string` | opcional | — | — | `"texto"` |
| `directDebitAgency` | `string` | opcional | — | — | `"texto"` |
| `directDebitAgencyDigit` | `string` | opcional | — | — | `"texto"` |
| `directDebitAccount` | `string` | opcional | — | — | `"texto"` |
| `directDebitAccountDigit` | `string` | opcional | — | — | `"texto"` |
| `directDebitReason` | `string` | opcional | — | — | `"texto"` |
| `bonusDiscountDay` | `string` | opcional | — | — | `"texto"` |
| `addressingAutomaticDebitNotification` | `string` | opcional | — | — | `"texto"` |
| `identificationBillingSlipIssuance` | `string` | opcional | — | — | `"texto"` |
| `acceptanceIdentification` | `string` | opcional | — | — | `"01310930"` |
| `depositoryAgency` | `string` | opcional | — | — | `"texto"` |
| `billingBankCharge` | `string` | opcional | — | — | `"texto"` |
| `bankCode` | `string` | opcional | — | — | `"texto"` |
| `iof` | `string` | opcional | — | — | `"texto"` |
| `bankingOperationIdentification` | `string` | opcional | — | — | `"texto"` |
| `creditDistributionIdentification` | `string` | opcional | — | — | `"texto"` |
| `participantControlNumber` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "documentNumber": "texto",
  "amount": 0,
  "description": "texto",
  "dueDate": "texto",
  "discount": 0,
  "discountLimitDate": "texto",
  "discount2": 0,
  "discountLimitDate2": "texto",
  "discount3": 0,
  "discountLimitDate3": "texto",
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tags": [
    "texto"
  ],
  "payer": {
    "name": "Fulano de Tal",
    "personTypeValue": "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,
  "settings": {
    "interestTypeValue": "texto",
    "interestAmount": 1000,
    "fineTypeValue": "texto",
    "fineAmount": 1000,
    "interestCodeValue": "texto"
  },
  "ourNumber": 0,
  "ourNumberDigit": "texto",
  "walletNumber": 0,
  "numberPayments": 0,
  "deduction": 0,
  "latePaymentInterestAmountPerDay": 0,
  "creditTypeValue": "texto",
  "conditionForIssuingBillingSlip": "texto",
  "directDebitAgency": "texto",
  "directDebitAgencyDigit": "texto",
  "directDebitAccount": "texto",
  "directDebitAccountDigit": "texto",
  "directDebitReason": "texto",
  "bonusDiscountDay": "texto",
  "addressingAutomaticDebitNotification": "texto",
  "identificationBillingSlipIssuance": "texto",
  "acceptanceIdentification": "01310930",
  "depositoryAgency": "texto",
  "billingBankCharge": "texto",
  "bankCode": "texto",
  "iof": "texto",
  "bankingOperationIdentification": "texto",
  "creditDistributionIdentification": "texto",
  "participantControlNumber": "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/Billing/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "documentNumber": "texto",
  "amount": 0,
  "description": "texto",
  "dueDate": "texto",
  "discount": 0,
  "discountLimitDate": "texto",
  "discount2": 0,
  "discountLimitDate2": "texto",
  "discount3": 0,
  "discountLimitDate3": "texto",
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tags": [
    "texto"
  ],
  "payer": {
    "name": "Fulano de Tal",
    "personTypeValue": "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,
  "settings": {
    "interestTypeValue": "texto",
    "interestAmount": 1000,
    "fineTypeValue": "texto",
    "fineAmount": 1000,
    "interestCodeValue": "texto"
  },
  "ourNumber": 0,
  "ourNumberDigit": "texto",
  "walletNumber": 0,
  "numberPayments": 0,
  "deduction": 0,
  "latePaymentInterestAmountPerDay": 0,
  "creditTypeValue": "texto",
  "conditionForIssuingBillingSlip": "texto",
  "directDebitAgency": "texto",
  "directDebitAgencyDigit": "texto",
  "directDebitAccount": "texto",
  "directDebitAccountDigit": "texto",
  "directDebitReason": "texto",
  "bonusDiscountDay": "texto",
  "addressingAutomaticDebitNotification": "texto",
  "identificationBillingSlipIssuance": "texto",
  "acceptanceIdentification": "01310930",
  "depositoryAgency": "texto",
  "billingBankCharge": "texto",
  "bankCode": "texto",
  "iof": "texto",
  "bankingOperationIdentification": "texto",
  "creditDistributionIdentification": "texto",
  "participantControlNumber": "texto"
}'
```

---

### POST /api/v1/Billing/BatchBillingRegistration

**Método de criação de cobranças em lote via importação de arquivo CSV** — Cria um novo registro de api.

Método de criação de cobranças em lote via importação de arquivo CSV.

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `totalItems` | `integer` | opcional | — | — | `0` |

Exemplo:

```json
{
  "totalItems": 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/Billing/BatchBillingRegistration" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /api/v1/Billing/{referenceId}/Cancel

**Método de exclusão de uma cobrança específica** — Cria um novo registro de api.

Método de exclusão de uma cobrança específica.

**Parâmetros**

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

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `isPaid` | `boolean` | opcional | — | — | `true` |
| `channelSettlement` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"Wallet"` |

Exemplo:

```json
{
  "isPaid": true,
  "channelSettlement": "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/Billing/3fa85f64-5717-4562-b3fc-2c963f66afa6/Cancel" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "isPaid": true,
  "channelSettlement": "Wallet"
}'
```

---

### POST /api/v1/Billing/{referenceId}/SettlementPartial

**Método de liquidação parcial de uma cobrança específica** — Cria um novo registro de api.

Método de liquidação parcial de uma cobrança específica.

**Parâmetros**

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

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `paidAmount` | `integer (int64)` | opcional | — | — | `1` |
| `paymentDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
{
  "paidAmount": 1,
  "paymentDate": "2025-08-11T13:45:00Z"
}
```

**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/Billing/3fa85f64-5717-4562-b3fc-2c963f66afa6/SettlementPartial" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "paidAmount": 1,
  "paymentDate": "2025-08-11T13:45:00Z"
}'
```

---

### POST /api/v1/Billing/{billingId}/Register

**Método responsável por registrar uma cobrança específica** — Cria um novo registro de api.

Método responsável por registrar uma cobrança específica.

**Parâmetros**

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

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `paymentMethods` | `array de string` | opcional | — | `BankSlip`, `Pix` | `[ … ]` |

Exemplo:

```json
{
  "paymentMethods": [
    "BankSlip"
  ]
}
```

**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/Billing/3fa85f64-5717-4562-b3fc-2c963f66afa6/Register" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "paymentMethods": [
    "BankSlip"
  ]
}'
```

---

### GET /api/v1/Billing/Tags

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

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

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `SearchString` | query | `string` | opcional | — | `valor` |
| `WalletCode` | query | `integer (int64)` | opcional | — | `10` |
| `Size` | query | `integer` | opcional | — | `10` |

**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 GET "{{baseUrl}}/api/v1/Billing/Tags" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /api/v1/Billing/{referenceId}/Transfer

**Método utilizado para transferir uma cobrança especifica entre carteiras/convenios** — Cria um novo registro de api.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `referenceId` | path | `string` | obrigatório | identificação da cobrança | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `UseExternalIdAsReference` | query | `boolean` | opcional | — | `true` |

**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/Billing/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/Billing/{billingId}/SendEmail

**Método responsável enviar uma cobrança via e-mail** — Cria um novo registro de api.

Método responsável enviar uma cobrança via e-mail.

**Parâmetros**

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

**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 POST "{{baseUrl}}/api/v1/Billing/3fa85f64-5717-4562-b3fc-2c963f66afa6/SendEmail" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /api/v1/Billing/ExportAsCNAB

**Método de exportação de cobranças em formato CNAB 400** — Lista e filtra registros de api.

Método de exportação de cobranças em formato CNAB 400, com base em cobranças selecionadas

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `Registered` | query | `boolean` | opcional | — | `true` |
| `Amount` | query | `integer (int64)` | opcional | — | `10` |
| `DocumentNumber` | query | `string` | opcional | — | `valor` |
| `BarCode` | query | `string` | opcional | — | `valor` |
| `SearchString` | query | `string` | opcional | — | `valor` |
| `Tags` | query | `array de string` | opcional | — | `valor` |
| `StatusesValue` | query | `array de string` | opcional | — | `valor` |
| `ExcludeStatusesValue` | query | `array de string` | opcional | — | `valor` |
| `WalletsCode` | query | `array de integer (int64)` | opcional | — | `valor` |
| `BankSlipId` | query | `string` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `InitialDueDate` | query | `string (date-time)` | opcional | — | `valor` |
| `FinalDueDate` | query | `string (date-time)` | opcional | — | `valor` |
| `InitialSettlementDate` | query | `string (date-time)` | opcional | — | `valor` |
| `FinalSettlementDate` | query | `string (date-time)` | opcional | — | `valor` |
| `PayerName` | query | `string` | opcional | — | `valor` |
| `Tenant` | query | `string` | opcional | — | `uy3` |
| `PayerRegistrationNumber` | query | `string` | opcional | — | `valor` |
| `FirstInstructionDebtCollection` | query | `string` | opcional | — | `valor` |
| `BillingIds` | query | `array de string` | opcional | — | `valor` |

**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/Billing/ExportAsCNAB" \
  -H "Authorization: Bearer {{token}}"
```

---

### PUT /api/v1/Billing/{billingId}/UpdateCommunicationSetting

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

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `billingId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `communicationSettingId` | query | `string` | opcional | — | `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 PUT "{{baseUrl}}/api/v1/Billing/3fa85f64-5717-4562-b3fc-2c963f66afa6/UpdateCommunicationSetting" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /api/v1/Billing/{billingId}/CancelReturnedFromDebtCollection

**Criar api** — Cria um novo registro de api.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `billingId` | 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/Billing/3fa85f64-5717-4562-b3fc-2c963f66afa6/CancelReturnedFromDebtCollection" \
  -H "Authorization: Bearer {{token}}"
```

---