# Crédito — Operação de crédito (UY3)

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

## Operação de crédito

Crie a operação, anexe documentos, envie para aprovação e acompanhe o status.

### POST /v{version}/CreditNote

**Cria uma nova solicitação de operação de crédito (CCB, CDC** — Cria um novo registro de Credit Note.

Cria uma nova solicitação de operação de crédito (CCB, CDC, Financiamento Estudantil, etc)

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `version` | path | `string` | obrigatório | — | `1` |
| `updateStartDate` | query | `boolean` | opcional | — | `true` |
| `returnValue` | query | `string` | opcional | — | `valor` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `productId` | `string (uuid)` | obrigatório | produto contratado | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `warranty` | `array de objeto` | opcional | Garantia de Bens | — | `[ … ]` |
| `emissionDate` | `string (date-time)` | opcional | Data de emissão do contrato | — | `"2025-08-11T13:45:00Z"` |
| `amortization` | `objeto` | obrigatório | Parâmetros da operação | varia conforme o tipo — ver exemplo | `{ … }` |
| `personId` | `string (uuid)` | obrigatório | Pessoa tomadora | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `liquidationType` | `string` | opcional | — | `Invoice`, `EletronicTransfer` | `"Invoice"` |
| `invoiceBarCode` | `string` | opcional | Linha digitável, para quando o tipo de liquidação é por boleto | — | `"texto"` |
| `beneficiaryId` | `string (uuid)` | opcional | Benefiário da operação | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `collateral` | `string` | opcional | Dados da garantia da operação | — | `"texto"` |
| `observations` | `string` | opcional | Observações gerais sobre a operação que poderão ser levadas em consideração pela mesa | — | `"texto"` |
| `status` | `string` | opcional | — | `Draft`, `ComplianceApproval`, `Signatures`, `Liquidation`, `Finished`, `Disapproved`, `Error`, `Revision`, `CreditApproval`, `InstrumentApproval`, `Canceled`, `WaitLiquidation`, `SignaturesValidation`, `PaymentRevision`, `ManualLiquidation`, `Warranty`, `ManualWarranty`, `MarginReserveApproval`, `WarrantyRevision`, `PartnerSignaturesValidation`, `OpenAccountRevision`, `VehicleInspection`, `VehicleInspectionApproval`, `GravameRegistration` | `"Draft"` |
| `bankAccountId` | `string (uuid)` | opcional | Conta bancária | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `isRegistered` | `boolean` | opcional | Indica se há registro em uma Registradora de Recebíveis | — | `true` |
| `bulkAssignment` | `boolean` | opcional | Indica se terá cessão em lote | — | `true` |
| `invoiceValue` | `integer (int64)` | opcional | Valor em centavos da nota fiscal | — | `0` |
| `invoiceNumber` | `string` | opcional | Número da nota fiscal (44 dígitos) | — | `"texto"` |
| `changeBankAccountId` | `string (uuid)` | opcional | Conta bancária de troco | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `issueNumber` | `integer` | opcional | Numero de série da nota comercial | — | `0` |
| `emissionNumber` | `integer` | opcional | Numero de emissão da nota comercial | — | `0` |
| `quantity` | `integer` | opcional | Quantidade de notas comerciais | — | `0` |
| `unitPrice` | `integer (int64)` | opcional | Valor unitario da nota comercial | — | `0` |
| `assignmentCalculation` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `assets` | `array de objeto` | opcional | Lista de IDs das garantias vinculadas à operação. São bens/diretos da(s) PFs ou PJs vinculadas à operação | objeto — ver detalhe abaixo | `[ … ]` |
| `relatedPersonCreditNote` | `array de objeto` | opcional | Lista das pessoas relacionadas a operação. | objeto — ver detalhe abaixo | `[ … ]` |
| `uploads` | `array de objeto` | opcional | Lista de arquivos relacionadas a operação. | objeto — ver detalhe abaixo | `[ … ]` |
| `paymentScheduleItems` | `array de objeto` | opcional | Lista de parcelas relacionadas a operação. | objeto — ver detalhe abaixo | `[ … ]` |
| `unicoSignScore` | `number (double)` | opcional | Score na Unico | — | `1000` |
| `facialSimilarityScore` | `number (double)` | opcional | Score na Unico | — | `1000` |
| `transitoryBankAccountId` | `string (uuid)` | opcional | Conta transitório do Roteiro de Liquidação | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `transitoryBankAccountOpenAccount` | `boolean` | opcional | — | — | `true` |
| `liquidationMode` | `string` | opcional | — | `Simple`, `LiquidationSchedule` | `"Simple"` |
| `liquidationSchedule` | `array de objeto` | opcional | Roteiro de liquidação | objeto — ver detalhe abaixo | `[ … ]` |
| `signatureDetails` | `array de objeto` | opcional | Dados da assinatura eletrônica de envolvidos | objeto — ver detalhe abaixo | `[ … ]` |
| `newPersonAndAccount` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `insurance` | `boolean` | opcional | Indica se a operação possui seguro | — | `true` |
| `dataprevOfferCTPSRequestId` | `integer (int64)` | opcional | RequestId da oferta CTPS de origem (espelho de DataprevEmployeeOfferCTPS.RequestId). Informado apenas quando a operação é criada a partir do leilão. Default null. | — | `1` |
| `isByxCreation` | `boolean` | opcional | Flag para indicar se a operação foi enviada pela BYX | — | `true` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `groupId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `assignmentCalculation`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amount` | `number (double)` | opcional | — | — | `1000` |
| `type` | `string` | opcional | — | `Absolute`, `Percentage` | `"Absolute"` |
| `mode` | `string` | opcional | — | `InitialValue`, `PresentValuePayment`, `PresentValueCreditNote`, `Default` | `"InitialValue"` |

Detalhe de `assets`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Detalhe de `relatedPersonCreditNote`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `typeOfRelationship` | `string` | obrigatório | — | `Issuer`, `PartnerGuarantor`, `Guarantor`, `Proxy`, `ProxyGuarantor`, `Partner`, `Spouse`, `Consenter`, `Witness`, `Assignor`, `Assignee`, `Endorser`, `Employer`, `Creditor`, `Debtor`, `PartnerDebtor`, `BillingAgent`, `BillingAgentApproverUser`, `Beneficiary`, `NotaryAgent`, `SettlementAgent`, `CreditorEndorser`, `FaithfulCustodian`, `JointGuarantor`, `ThirdPartyGuarantor`, `LegalRepresentative`, `InsuranceCompany`, `Presidente`, `Administrador`, `Diretor` | `"Issuer"` |
| `relatedToId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `signatureType` | `string` | opcional | — | `email`, `sms`, `whatsapp` | `"email"` |
| `signatureValidation` | `string` | opcional | — | `EletronicSignatureAndDocument`, `SelfieSignature`, `SelfieDocumentSignature`, `FacialBiometrics`, `DigitalCertificate`, `EletronicSignature` | `"EletronicSignatureAndDocument"` |
| `percentage` | `number (double)` | opcional | — | — | `1.99` |

Detalhe de `uploads`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `fileType` | `string` | obrigatório | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement`, `WarrantyRegistrationOfficeProof`, `OperationHistory`, `VehicleInspection`, `InsuranceCancellationTemplate`, `SignatureTemplateDraft`, `InssDefermentReport`, `InssMedicalReview` | `"Document"` |
| `fileName` | `string` | obrigatório | Nome do arquivo (retornado pelo GET v1/Upload) | — | `"Fulano de Tal"` |
| `displayName` | `string` | opcional | Nome de exibição do arquivo | — | `"Fulano de Tal"` |
| `documentDate` | `string (date-time)` | opcional | Data do próprio documento (emissão/referência), não a data do upload. Aceita em qualquer tipo de documento e sempre opcional.   Só tem efeito de negócio no laudo de deferimento INSS e na última perícia INSS, cujos valores são comparados aos cortes da regra de elegibilidade dos benefícios 32/92 (faixa 45–54); nos demais tipos é apenas informativa. | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `paymentScheduleItems`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `dueDate` | `string (date-time)` | opcional | Data de vencimento da parcela | — | `"2025-08-11T13:45:00Z"` |
| `principalAmountInCents` | `integer (int64)` | opcional | Saldo devedor da parcela após a apuração de amortização e juros | — | `0` |
| `amortization` | `integer (int64)` | opcional | Valor amortizado (principal) na parcela | — | `0` |
| `interest` | `integer (int64)` | opcional | Juros apurados no período | — | `0` |
| `financeTax` | `integer (int64)` | opcional | Valor de IOF que incide sob a parcela (IOF diário + parcela do IOF base) | — | `0` |
| `addedFixedCosts` | `integer (int64)` | opcional | Valor de tarifas adicionais que devem ser incluídas em cada parcela (valor não é financiado) | — | `0` |
| `payment` | `integer (int64)` | opcional | Valor da parcela que será pago pelo devedor no vencimento | — | `0` |

Detalhe de `liquidationSchedule`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amountInCents` | `integer (int64)` | obrigatório | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `signatureDetails`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `userAgent` | `string` | opcional | — | — | `"texto"` |
| `ip` | `string` | opcional | — | — | `"texto"` |
| `geoLocation` | `string` | opcional | — | — | `"texto"` |
| `operationalSystem` | `string` | opcional | — | — | `"texto"` |
| `deviceModel` | `string` | opcional | — | — | `"texto"` |
| `deviceName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `deviceType` | `string` | opcional | — | — | `"texto"` |
| `smsValidation` | `boolean` | opcional | — | — | `true` |
| `emailValidation` | `boolean` | opcional | — | — | `true` |

Detalhe de `newPersonAndAccount`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personType` | `string` | opcional | — | `Natural`, `Legal` | `"Natural"` |
| `listBankAccounts` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `pixQrCode`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `qrCode` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `bankSlip`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barcodeOrDigitableLine` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | obrigatório | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | obrigatório | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |

Detalhe de `listBankAccounts`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `bankIspb` | `integer (int64)` | opcional | Código ISPB do banco | — | `0` |
| `account` | `string` | opcional | — | — | `"texto"` |
| `accountDigit` | `string` | opcional | — | — | `"texto"` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `agencyDigit` | `string` | opcional | — | — | `"texto"` |
| `type` | `string` | opcional | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |
| `jointAccount` | `boolean` | opcional | — | — | `true` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `keyPix` | `string` | opcional | chave pix | — | `"texto"` |

Exemplo:

```json
{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "warranty": [
    {
      "warrantyType": "Warranty"
    }
  ],
  "emissionDate": "2025-08-11T13:45:00Z",
  "amortization": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "amortizationType": "texto",
    "startDate": "2025-08-11T13:45:00Z",
    "apr": 1.99,
    "includePaymentFixedCosts": true,
    "validationErrors": [
      {
        "memberNames": [],
        "errorMessage": "texto"
      }
    ],
    "agentCommissions": [
      {
        "name": "Fulano de Tal",
        "amount": 1000,
        "type": {},
        "baseValue": {},
        "chargeCommissionFrom": {},
        "financeCost": true
      }
    ],
    "agentCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "type": "Absolute",
      "baseValue": "InitialValue",
      "chargeCommissionFrom": "All",
      "financeCost": true,
      "totalValue": 0
    }
  },
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "liquidationType": "Invoice",
  "invoiceBarCode": "texto",
  "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "collateral": "texto",
  "observations": "texto",
  "status": "Draft",
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isRegistered": true,
  "bulkAssignment": true,
  "invoiceValue": 0,
  "invoiceNumber": "texto",
  "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "issueNumber": 0,
  "emissionNumber": 0,
  "quantity": 0,
  "unitPrice": 0,
  "assignmentCalculation": {
    "amount": 1000,
    "type": "Absolute",
    "mode": "InitialValue"
  },
  "assets": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "relatedPersonCreditNote": [
    {
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "typeOfRelationship": "Issuer",
      "relatedToId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "signatureType": "email",
      "signatureValidation": "EletronicSignatureAndDocument",
      "percentage": 1.99
    }
  ],
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "fileType": "Document",
      "fileName": "Fulano de Tal",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ],
  "paymentScheduleItems": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "dueDate": "2025-08-11T13:45:00Z",
      "principalAmountInCents": 0,
      "amortization": 0,
      "interest": 0,
      "financeTax": 0,
      "addedFixedCosts": 0,
      "payment": 0
    }
  ],
  "unicoSignScore": 1000,
  "facialSimilarityScore": 1000,
  "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "transitoryBankAccountOpenAccount": true,
  "liquidationMode": "Simple",
  "liquidationSchedule": [
    {
      "amountInCents": 0,
      "pixQrCode": {
        "qrCode": "texto"
      },
      "bankSlip": {
        "barcodeOrDigitableLine": "texto"
      },
      "pixKey": {
        "key": "texto",
        "pixKeyType": {},
        "typeDisplay": "texto"
      },
      "transfer": {
        "to": {},
        "type": {}
      },
      "description": "texto",
      "informedDueDate": "2025-08-11T13:45:00Z"
    }
  ],
  "signatureDetails": [
    {
      "registrationNumber": "12345678909",
      "userAgent": "texto",
      "ip": "texto",
      "geoLocation": "texto",
      "operationalSystem": "texto",
      "deviceModel": "texto",
      "deviceName": "Fulano de Tal",
      "deviceType": "texto",
      "smsValidation": true,
      "emailValidation": true
    }
  ],
  "newPersonAndAccount": {
    "personType": "Natural",
    "listBankAccounts": [
      {
        "ownerUser": {},
        "ownerGroup": {},
        "bankCode": 0,
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": {},
        "jointAccount": true,
        "operationTypeValue": {},
        "pixKeyTypeValue": {},
        "keyPix": "texto"
      }
    ]
  },
  "insurance": true,
  "dataprevOfferCTPSRequestId": 1,
  "isByxCreation": true
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "warranty": [
    {
      "warrantyType": "Warranty"
    }
  ],
  "emissionDate": "2025-08-11T13:45:00Z",
  "amortization": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "amortizationType": "texto",
    "startDate": "2025-08-11T13:45:00Z",
    "apr": 1.99,
    "includePaymentFixedCosts": true,
    "validationErrors": [
      {
        "memberNames": [],
        "errorMessage": "texto"
      }
    ],
    "agentCommissions": [
      {
        "name": "Fulano de Tal",
        "amount": 1000,
        "type": {},
        "baseValue": {},
        "chargeCommissionFrom": {},
        "financeCost": true
      }
    ],
    "agentCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "type": "Absolute",
      "baseValue": "InitialValue",
      "chargeCommissionFrom": "All",
      "financeCost": true,
      "totalValue": 0
    }
  },
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "liquidationType": "Invoice",
  "invoiceBarCode": "texto",
  "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "collateral": "texto",
  "observations": "texto",
  "status": "Draft",
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isRegistered": true,
  "bulkAssignment": true,
  "invoiceValue": 0,
  "invoiceNumber": "texto",
  "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "issueNumber": 0,
  "emissionNumber": 0,
  "quantity": 0,
  "unitPrice": 0,
  "assignmentCalculation": {
    "amount": 1000,
    "type": "Absolute",
    "mode": "InitialValue"
  },
  "assets": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "relatedPersonCreditNote": [
    {
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "typeOfRelationship": "Issuer",
      "relatedToId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "signatureType": "email",
      "signatureValidation": "EletronicSignatureAndDocument",
      "percentage": 1.99
    }
  ],
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "fileType": "Document",
      "fileName": "Fulano de Tal",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ],
  "paymentScheduleItems": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "dueDate": "2025-08-11T13:45:00Z",
      "principalAmountInCents": 0,
      "amortization": 0,
      "interest": 0,
      "financeTax": 0,
      "addedFixedCosts": 0,
      "payment": 0
    }
  ],
  "unicoSignScore": 1000,
  "facialSimilarityScore": 1000,
  "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "transitoryBankAccountOpenAccount": true,
  "liquidationMode": "Simple",
  "liquidationSchedule": [
    {
      "amountInCents": 0,
      "pixQrCode": {
        "qrCode": "texto"
      },
      "bankSlip": {
        "barcodeOrDigitableLine": "texto"
      },
      "pixKey": {
        "key": "texto",
        "pixKeyType": {},
        "typeDisplay": "texto"
      },
      "transfer": {
        "to": {},
        "type": {}
      },
      "description": "texto",
      "informedDueDate": "2025-08-11T13:45:00Z"
    }
  ],
  "signatureDetails": [
    {
      "registrationNumber": "12345678909",
      "userAgent": "texto",
      "ip": "texto",
      "geoLocation": "texto",
      "operationalSystem": "texto",
      "deviceModel": "texto",
      "deviceName": "Fulano de Tal",
      "deviceType": "texto",
      "smsValidation": true,
      "emailValidation": true
    }
  ],
  "newPersonAndAccount": {
    "personType": "Natural",
    "listBankAccounts": [
      {
        "ownerUser": {},
        "ownerGroup": {},
        "bankCode": 0,
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": {},
        "jointAccount": true,
        "operationTypeValue": {},
        "pixKeyTypeValue": {},
        "keyPix": "texto"
      }
    ]
  },
  "insurance": true,
  "dataprevOfferCTPSRequestId": 1,
  "isByxCreation": true
}'
```

---

### POST /v{version}/CreditNote/Batch

**Cria múltiplas operações de crédito, relacionadas entre si** — Cria um novo registro de Credit Note.

Cria múltiplas operações de crédito, relacionadas entre si. Operações relacionadas terão um fluxo de assinaturas unificado.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `version` | path | `string` | obrigatório | — | `1` |
| `updateStartDate` | query | `boolean` | opcional | — | `true` |
| `doStepBatchSignature` | query | `boolean` | opcional | — | `true` |
| `mergeDocumentsForSignature` | query | `boolean` | opcional | — | `true` |
| `returnValue` | query | `string` | opcional | — | `valor` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `productId` | `string (uuid)` | obrigatório | produto contratado | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `warranty` | `array de objeto` | opcional | Garantia de Bens | — | `[ … ]` |
| `emissionDate` | `string (date-time)` | opcional | Data de emissão do contrato | — | `"2025-08-11T13:45:00Z"` |
| `amortization` | `objeto` | obrigatório | Parâmetros da operação | varia conforme o tipo — ver exemplo | `{ … }` |
| `personId` | `string (uuid)` | obrigatório | Pessoa tomadora | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `liquidationType` | `string` | opcional | — | `Invoice`, `EletronicTransfer` | `"Invoice"` |
| `invoiceBarCode` | `string` | opcional | Linha digitável, para quando o tipo de liquidação é por boleto | — | `"texto"` |
| `beneficiaryId` | `string (uuid)` | opcional | Benefiário da operação | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `collateral` | `string` | opcional | Dados da garantia da operação | — | `"texto"` |
| `observations` | `string` | opcional | Observações gerais sobre a operação que poderão ser levadas em consideração pela mesa | — | `"texto"` |
| `status` | `string` | opcional | — | `Draft`, `ComplianceApproval`, `Signatures`, `Liquidation`, `Finished`, `Disapproved`, `Error`, `Revision`, `CreditApproval`, `InstrumentApproval`, `Canceled`, `WaitLiquidation`, `SignaturesValidation`, `PaymentRevision`, `ManualLiquidation`, `Warranty`, `ManualWarranty`, `MarginReserveApproval`, `WarrantyRevision`, `PartnerSignaturesValidation`, `OpenAccountRevision`, `VehicleInspection`, `VehicleInspectionApproval`, `GravameRegistration` | `"Draft"` |
| `bankAccountId` | `string (uuid)` | opcional | Conta bancária | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `isRegistered` | `boolean` | opcional | Indica se há registro em uma Registradora de Recebíveis | — | `true` |
| `bulkAssignment` | `boolean` | opcional | Indica se terá cessão em lote | — | `true` |
| `invoiceValue` | `integer (int64)` | opcional | Valor em centavos da nota fiscal | — | `0` |
| `invoiceNumber` | `string` | opcional | Número da nota fiscal (44 dígitos) | — | `"texto"` |
| `changeBankAccountId` | `string (uuid)` | opcional | Conta bancária de troco | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `issueNumber` | `integer` | opcional | Numero de série da nota comercial | — | `0` |
| `emissionNumber` | `integer` | opcional | Numero de emissão da nota comercial | — | `0` |
| `quantity` | `integer` | opcional | Quantidade de notas comerciais | — | `0` |
| `unitPrice` | `integer (int64)` | opcional | Valor unitario da nota comercial | — | `0` |
| `assignmentCalculation` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `assets` | `array de objeto` | opcional | Lista de IDs das garantias vinculadas à operação. São bens/diretos da(s) PFs ou PJs vinculadas à operação | objeto — ver detalhe abaixo | `[ … ]` |
| `relatedPersonCreditNote` | `array de objeto` | opcional | Lista das pessoas relacionadas a operação. | objeto — ver detalhe abaixo | `[ … ]` |
| `uploads` | `array de objeto` | opcional | Lista de arquivos relacionadas a operação. | objeto — ver detalhe abaixo | `[ … ]` |
| `paymentScheduleItems` | `array de objeto` | opcional | Lista de parcelas relacionadas a operação. | objeto — ver detalhe abaixo | `[ … ]` |
| `unicoSignScore` | `number (double)` | opcional | Score na Unico | — | `1000` |
| `facialSimilarityScore` | `number (double)` | opcional | Score na Unico | — | `1000` |
| `transitoryBankAccountId` | `string (uuid)` | opcional | Conta transitório do Roteiro de Liquidação | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `transitoryBankAccountOpenAccount` | `boolean` | opcional | — | — | `true` |
| `liquidationMode` | `string` | opcional | — | `Simple`, `LiquidationSchedule` | `"Simple"` |
| `liquidationSchedule` | `array de objeto` | opcional | Roteiro de liquidação | objeto — ver detalhe abaixo | `[ … ]` |
| `signatureDetails` | `array de objeto` | opcional | Dados da assinatura eletrônica de envolvidos | objeto — ver detalhe abaixo | `[ … ]` |
| `newPersonAndAccount` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `insurance` | `boolean` | opcional | Indica se a operação possui seguro | — | `true` |
| `dataprevOfferCTPSRequestId` | `integer (int64)` | opcional | RequestId da oferta CTPS de origem (espelho de DataprevEmployeeOfferCTPS.RequestId). Informado apenas quando a operação é criada a partir do leilão. Default null. | — | `1` |
| `isByxCreation` | `boolean` | opcional | Flag para indicar se a operação foi enviada pela BYX | — | `true` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `groupId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `assignmentCalculation`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amount` | `number (double)` | opcional | — | — | `1000` |
| `type` | `string` | opcional | — | `Absolute`, `Percentage` | `"Absolute"` |
| `mode` | `string` | opcional | — | `InitialValue`, `PresentValuePayment`, `PresentValueCreditNote`, `Default` | `"InitialValue"` |

Detalhe de `assets`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Detalhe de `relatedPersonCreditNote`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `typeOfRelationship` | `string` | obrigatório | — | `Issuer`, `PartnerGuarantor`, `Guarantor`, `Proxy`, `ProxyGuarantor`, `Partner`, `Spouse`, `Consenter`, `Witness`, `Assignor`, `Assignee`, `Endorser`, `Employer`, `Creditor`, `Debtor`, `PartnerDebtor`, `BillingAgent`, `BillingAgentApproverUser`, `Beneficiary`, `NotaryAgent`, `SettlementAgent`, `CreditorEndorser`, `FaithfulCustodian`, `JointGuarantor`, `ThirdPartyGuarantor`, `LegalRepresentative`, `InsuranceCompany`, `Presidente`, `Administrador`, `Diretor` | `"Issuer"` |
| `relatedToId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `signatureType` | `string` | opcional | — | `email`, `sms`, `whatsapp` | `"email"` |
| `signatureValidation` | `string` | opcional | — | `EletronicSignatureAndDocument`, `SelfieSignature`, `SelfieDocumentSignature`, `FacialBiometrics`, `DigitalCertificate`, `EletronicSignature` | `"EletronicSignatureAndDocument"` |
| `percentage` | `number (double)` | opcional | — | — | `1.99` |

Detalhe de `uploads`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `fileType` | `string` | obrigatório | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement`, `WarrantyRegistrationOfficeProof`, `OperationHistory`, `VehicleInspection`, `InsuranceCancellationTemplate`, `SignatureTemplateDraft`, `InssDefermentReport`, `InssMedicalReview` | `"Document"` |
| `fileName` | `string` | obrigatório | Nome do arquivo (retornado pelo GET v1/Upload) | — | `"Fulano de Tal"` |
| `displayName` | `string` | opcional | Nome de exibição do arquivo | — | `"Fulano de Tal"` |
| `documentDate` | `string (date-time)` | opcional | Data do próprio documento (emissão/referência), não a data do upload. Aceita em qualquer tipo de documento e sempre opcional.   Só tem efeito de negócio no laudo de deferimento INSS e na última perícia INSS, cujos valores são comparados aos cortes da regra de elegibilidade dos benefícios 32/92 (faixa 45–54); nos demais tipos é apenas informativa. | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `paymentScheduleItems`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `dueDate` | `string (date-time)` | opcional | Data de vencimento da parcela | — | `"2025-08-11T13:45:00Z"` |
| `principalAmountInCents` | `integer (int64)` | opcional | Saldo devedor da parcela após a apuração de amortização e juros | — | `0` |
| `amortization` | `integer (int64)` | opcional | Valor amortizado (principal) na parcela | — | `0` |
| `interest` | `integer (int64)` | opcional | Juros apurados no período | — | `0` |
| `financeTax` | `integer (int64)` | opcional | Valor de IOF que incide sob a parcela (IOF diário + parcela do IOF base) | — | `0` |
| `addedFixedCosts` | `integer (int64)` | opcional | Valor de tarifas adicionais que devem ser incluídas em cada parcela (valor não é financiado) | — | `0` |
| `payment` | `integer (int64)` | opcional | Valor da parcela que será pago pelo devedor no vencimento | — | `0` |

Detalhe de `liquidationSchedule`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amountInCents` | `integer (int64)` | obrigatório | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `signatureDetails`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `userAgent` | `string` | opcional | — | — | `"texto"` |
| `ip` | `string` | opcional | — | — | `"texto"` |
| `geoLocation` | `string` | opcional | — | — | `"texto"` |
| `operationalSystem` | `string` | opcional | — | — | `"texto"` |
| `deviceModel` | `string` | opcional | — | — | `"texto"` |
| `deviceName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `deviceType` | `string` | opcional | — | — | `"texto"` |
| `smsValidation` | `boolean` | opcional | — | — | `true` |
| `emailValidation` | `boolean` | opcional | — | — | `true` |

Detalhe de `newPersonAndAccount`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personType` | `string` | opcional | — | `Natural`, `Legal` | `"Natural"` |
| `listBankAccounts` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `pixQrCode`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `qrCode` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `bankSlip`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barcodeOrDigitableLine` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | obrigatório | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | obrigatório | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |

Detalhe de `listBankAccounts`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `bankIspb` | `integer (int64)` | opcional | Código ISPB do banco | — | `0` |
| `account` | `string` | opcional | — | — | `"texto"` |
| `accountDigit` | `string` | opcional | — | — | `"texto"` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `agencyDigit` | `string` | opcional | — | — | `"texto"` |
| `type` | `string` | opcional | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |
| `jointAccount` | `boolean` | opcional | — | — | `true` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `keyPix` | `string` | opcional | chave pix | — | `"texto"` |

Exemplo:

```json
[
  {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "warranty": [
      {
        "warrantyType": "Warranty"
      }
    ],
    "emissionDate": "2025-08-11T13:45:00Z",
    "amortization": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "amortizationType": "texto",
      "startDate": "2025-08-11T13:45:00Z",
      "apr": 1.99,
      "includePaymentFixedCosts": true,
      "validationErrors": [
        {
          "memberNames": [],
          "errorMessage": "texto"
        }
      ],
      "agentCommissions": [
        {
          "name": "Fulano de Tal",
          "amount": 1000,
          "type": {},
          "baseValue": {},
          "chargeCommissionFrom": {},
          "financeCost": true
        }
      ],
      "agentCommission": {
        "name": "Fulano de Tal",
        "amount": 1000,
        "type": "Absolute",
        "baseValue": "InitialValue",
        "chargeCommissionFrom": "All",
        "financeCost": true,
        "totalValue": 0
      }
    },
    "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "liquidationType": "Invoice",
    "invoiceBarCode": "texto",
    "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "collateral": "texto",
    "observations": "texto",
    "status": "Draft",
    "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "isRegistered": true,
    "bulkAssignment": true,
    "invoiceValue": 0,
    "invoiceNumber": "texto",
    "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "issueNumber": 0,
    "emissionNumber": 0,
    "quantity": 0,
    "unitPrice": 0,
    "assignmentCalculation": {
      "amount": 1000,
      "type": "Absolute",
      "mode": "InitialValue"
    },
    "assets": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ],
    "relatedPersonCreditNote": [
      {
        "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "typeOfRelationship": "Issuer",
        "relatedToId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "signatureType": "email",
        "signatureValidation": "EletronicSignatureAndDocument",
        "percentage": 1.99
      }
    ],
    "uploads": [
      {
        "ownerUser": {
          "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "ownerGroup": {
          "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "fileType": "Document",
        "fileName": "Fulano de Tal",
        "displayName": "Fulano de Tal",
        "documentDate": "2025-08-11T13:45:00Z"
      }
    ],
    "paymentScheduleItems": [
      {
        "ownerUser": {
          "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "ownerGroup": {
          "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "dueDate": "2025-08-11T13:45:00Z",
        "principalAmountInCents": 0,
        "amortization": 0,
        "interest": 0,
        "financeTax": 0,
        "addedFixedCosts": 0,
        "payment": 0
      }
    ],
    "unicoSignScore": 1000,
    "facialSimilarityScore": 1000,
    "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "transitoryBankAccountOpenAccount": true,
    "liquidationMode": "Simple",
    "liquidationSchedule": [
      {
        "amountInCents": 0,
        "pixQrCode": {
          "qrCode": "texto"
        },
        "bankSlip": {
          "barcodeOrDigitableLine": "texto"
        },
        "pixKey": {
          "key": "texto",
          "pixKeyType": {},
          "typeDisplay": "texto"
        },
        "transfer": {
          "to": {},
          "type": {}
        },
        "description": "texto",
        "informedDueDate": "2025-08-11T13:45:00Z"
      }
    ],
    "signatureDetails": [
      {
        "registrationNumber": "12345678909",
        "userAgent": "texto",
        "ip": "texto",
        "geoLocation": "texto",
        "operationalSystem": "texto",
        "deviceModel": "texto",
        "deviceName": "Fulano de Tal",
        "deviceType": "texto",
        "smsValidation": true,
        "emailValidation": true
      }
    ],
    "newPersonAndAccount": {
      "personType": "Natural",
      "listBankAccounts": [
        {
          "ownerUser": {},
          "ownerGroup": {},
          "bankCode": 0,
          "bankIspb": 0,
          "account": "texto",
          "accountDigit": "texto",
          "agency": "texto",
          "agencyDigit": "texto",
          "type": {},
          "jointAccount": true,
          "operationTypeValue": {},
          "pixKeyTypeValue": {},
          "keyPix": "texto"
        }
      ]
    },
    "insurance": true,
    "dataprevOfferCTPSRequestId": 1,
    "isByxCreation": true
  }
]
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/Batch" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "warranty": [
      {
        "warrantyType": "Warranty"
      }
    ],
    "emissionDate": "2025-08-11T13:45:00Z",
    "amortization": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "amortizationType": "texto",
      "startDate": "2025-08-11T13:45:00Z",
      "apr": 1.99,
      "includePaymentFixedCosts": true,
      "validationErrors": [
        {
          "memberNames": [],
          "errorMessage": "texto"
        }
      ],
      "agentCommissions": [
        {
          "name": "Fulano de Tal",
          "amount": 1000,
          "type": {},
          "baseValue": {},
          "chargeCommissionFrom": {},
          "financeCost": true
        }
      ],
      "agentCommission": {
        "name": "Fulano de Tal",
        "amount": 1000,
        "type": "Absolute",
        "baseValue": "InitialValue",
        "chargeCommissionFrom": "All",
        "financeCost": true,
        "totalValue": 0
      }
    },
    "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "liquidationType": "Invoice",
    "invoiceBarCode": "texto",
    "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "collateral": "texto",
    "observations": "texto",
    "status": "Draft",
    "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "isRegistered": true,
    "bulkAssignment": true,
    "invoiceValue": 0,
    "invoiceNumber": "texto",
    "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "issueNumber": 0,
    "emissionNumber": 0,
    "quantity": 0,
    "unitPrice": 0,
    "assignmentCalculation": {
      "amount": 1000,
      "type": "Absolute",
      "mode": "InitialValue"
    },
    "assets": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ],
    "relatedPersonCreditNote": [
      {
        "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "typeOfRelationship": "Issuer",
        "relatedToId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "signatureType": "email",
        "signatureValidation": "EletronicSignatureAndDocument",
        "percentage": 1.99
      }
    ],
    "uploads": [
      {
        "ownerUser": {
          "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "ownerGroup": {
          "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "fileType": "Document",
        "fileName": "Fulano de Tal",
        "displayName": "Fulano de Tal",
        "documentDate": "2025-08-11T13:45:00Z"
      }
    ],
    "paymentScheduleItems": [
      {
        "ownerUser": {
          "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "ownerGroup": {
          "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "dueDate": "2025-08-11T13:45:00Z",
        "principalAmountInCents": 0,
        "amortization": 0,
        "interest": 0,
        "financeTax": 0,
        "addedFixedCosts": 0,
        "payment": 0
      }
    ],
    "unicoSignScore": 1000,
    "facialSimilarityScore": 1000,
    "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "transitoryBankAccountOpenAccount": true,
    "liquidationMode": "Simple",
    "liquidationSchedule": [
      {
        "amountInCents": 0,
        "pixQrCode": {
          "qrCode": "texto"
        },
        "bankSlip": {
          "barcodeOrDigitableLine": "texto"
        },
        "pixKey": {
          "key": "texto",
          "pixKeyType": {},
          "typeDisplay": "texto"
        },
        "transfer": {
          "to": {},
          "type": {}
        },
        "description": "texto",
        "informedDueDate": "2025-08-11T13:45:00Z"
      }
    ],
    "signatureDetails": [
      {
        "registrationNumber": "12345678909",
        "userAgent": "texto",
        "ip": "texto",
        "geoLocation": "texto",
        "operationalSystem": "texto",
        "deviceModel": "texto",
        "deviceName": "Fulano de Tal",
        "deviceType": "texto",
        "smsValidation": true,
        "emailValidation": true
      }
    ],
    "newPersonAndAccount": {
      "personType": "Natural",
      "listBankAccounts": [
        {
          "ownerUser": {},
          "ownerGroup": {},
          "bankCode": 0,
          "bankIspb": 0,
          "account": "texto",
          "accountDigit": "texto",
          "agency": "texto",
          "agencyDigit": "texto",
          "type": {},
          "jointAccount": true,
          "operationTypeValue": {},
          "pixKeyTypeValue": {},
          "keyPix": "texto"
        }
      ]
    },
    "insurance": true,
    "dataprevOfferCTPSRequestId": 1,
    "isByxCreation": true
  }
]'
```

---

### POST /v{version}/CreditNote/{id}/DuePaymentSchedule

**Calcular calendário de quitação** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `creditNoteId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `referenceDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `numberOfDays` | `integer` | opcional | — | — | `0` |

Exemplo:

```json
{
  "creditNoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "referenceDate": "2025-08-11T13:45:00Z",
  "numberOfDays": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/DuePaymentSchedule" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "creditNoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "referenceDate": "2025-08-11T13:45:00Z",
  "numberOfDays": 0
}'
```

---

### PUT /v{version}/CreditNote/{id}/upload

**Atualiza a lista de documentos atrelados à operação** — Atualiza por completo um registro de Credit Note existente.

Atualiza a lista de documentos atrelados à operação. Permitido apenas quando o status da operação é Rascunho, Revisão, Aprovação de Instrumento ou Coleta de Assinaturas.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `uploads` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `uploads`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | Id do arquivo | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `fileName` | `string` | obrigatório | Nome do arquivo (retornado pelo GET v1/Upload) | — | `"Fulano de Tal"` |
| `fileType` | `string` | opcional | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement`, `WarrantyRegistrationOfficeProof`, `OperationHistory`, `VehicleInspection`, `InsuranceCancellationTemplate`, `SignatureTemplateDraft`, `InssDefermentReport`, `InssMedicalReview` | `"Document"` |
| `displayName` | `string` | opcional | Nome de exibição do arquivo | — | `"Fulano de Tal"` |
| `documentDate` | `string (date-time)` | opcional | Data do próprio documento (emissão/referência), não a data do upload. Aceita em qualquer tipo de documento e sempre opcional. Só tem efeito de negócio no laudo de deferimento INSS e na última perícia INSS (regra de elegibilidade dos benefícios 32/92). | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `groupId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Exemplo:

```json
{
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/upload" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ]
}'
```

---

### PUT /v{version}/CreditNote/{id}/warranty

**Atualiza a lista de garantias atrelados à operação** — Atualiza por completo um registro de Credit Note existente.

Atualiza a lista de garantias atrelados à operação.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `productId` | `string (uuid)` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `warranty` | `array de objeto` | opcional | — | — | `[ … ]` |

Exemplo:

```json
{
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "warranty": [
    {
      "warrantyType": "Warranty"
    }
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/warranty" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "warranty": [
    {
      "warrantyType": "Warranty"
    }
  ]
}'
```

---

### GET /v{version}/CreditNote/{id}

**Obtém todas as informações de uma operação** — Consulta Credit Note pelo identificador informado na rota.

Obtém todas as informações de uma operação.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Resposta 200**

Exemplo:

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2025-08-11T13:45:00Z",
  "createdBy": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenant": "texto",
    "tenantName": "Fulano de Tal"
  },
  "tenant": "texto",
  "tenantDisplay": "texto",
  "updatedAt": "2025-08-11T13:45:00Z",
  "updatedBy": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenant": "texto",
    "tenantName": "Fulano de Tal"
  },
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenant": "texto",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupDisplay": "texto",
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "creditNoteNo": 0,
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "productIdDisplay": "texto",
  "productCategoryDisplay": "texto",
  "productInstrumentType": "texto",
  "acceptanceDate": "2025-08-11T13:45:00Z",
  "amortization": {
    "amortizationType": "texto",
    "calculateByValueType": "texto",
    "requestedAmount": 0,
    "principalAmountInCents": 0,
    "startDate": "2025-08-11T13:45:00Z",
    "termInMonths": 0,
    "numberOfPayments": 0,
    "paymentPeriodicity": {
      "every": 0,
      "periodicity": "texto"
    },
    "absAmortizationInMonths": 0,
    "absInterestInMonths": 0,
    "apr": 1.99,
    "periodicity": "texto",
    "daysInYear": 0,
    "agentCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "amountDisplay": "texto",
      "type": "texto",
      "baseValue": "texto",
      "chargeCommissionFrom": "texto",
      "financeCost": true
    },
    "calculationType": "texto",
    "firstPaymentDate": "2025-08-11T13:45:00Z",
    "bankCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "amountDisplay": "texto",
      "type": "texto",
      "baseValue": "texto",
      "chargeCommissionFrom": "texto",
      "financeCost": true
    },
    "financeOperationsTax": 1.99,
    "dailyFinanceOperationsTax": 1.99,
    "indexer": "texto",
    "indexerValue": 1000,
    "paymentDay": 0,
    "skippedMonths": [
      "texto"
    ],
    "monthlyInterest": 1000,
    "yearlyInterest": 1000,
    "effectiveMonthlyCost": 1000,
    "effectiveYearlyCost": 1000,
    "liquidValue": 1,
    "comm": 0,
    "commTc": 0,
    "commNonTc": 0,
    "finTax": 0,
    "dueDate": "2025-08-11T13:45:00Z",
    "initialValue": 0,
    "fixedPaymentDuringGraduation": 0,
    "termsUntilGraduation": 0,
    "absAfterGraduation": 0,
    "pmt2Value": 1000,
    "fiduciaryGuarantee": 1000,
    "financeTaxExempted": true,
    "issueNumber": 0,
    "emissionNumber": 0,
    "quantity": 0,
    "unitPrice": 0,
    "minEmissionCost": 0,
    "maxEmissionCost": 0,
    "numberOfInterestPayments": 0,
    "valueMarginReserve": 0,
    "insuranceCoverAmount": 0,
    "paymentFixedCosts": 0,
    "includePaymentFixedCosts": true,
    "dueDateOnBusinessDays": true,
    "discountMode": true
  },
  "warranty": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "warrantyType": "texto",
      "renavam": "texto",
      "typeOfVehicle": "texto",
      "chassis": "texto",
      "board": "texto",
      "plateState": "texto",
      "operationState": "texto",
      "supplier": "texto",
      "taxNumberOfSupplier": "texto",
      "brand": "texto",
      "color": "texto",
      "model": "texto",
      "yearOfManufacture": 0,
      "yearOfModel": 0,
      "typeOfFuel": "texto",
      "registryOffice": "texto",
      "registrationNumber": "12345678909",
      "width": 1000,
      "length": 1000,
      "addressName": "Fulano de Tal",
      "zipCodeAddress": "01310930",
      "city": "texto",
      "uf": "texto",
      "district": "texto",
      "addressNumber": "texto",
      "complementAddress": "texto",
      "propertyFeatures": "texto",
      "propertyValue": 0,
      "number": "texto",
      "court": "texto",
      "valueOfCause": 0,
      "claimant": "texto",
      "claimed": "texto",
      "typeOfProcess": "texto",
      "downPayment": 0,
      "sellerCompanyName": "Fulano de Tal",
      "sellerRegistrationNumber": "texto",
      "valueInCash": 0,
      "subtotalAmount": 0,
      "totalAmountFinancedTaxFree": 0,
      "register": "texto",
      "type": "texto",
      "splitMethodType": "texto",
      "paymentNetworks": [
        "texto"
      ],
      "constituted": true,
      "totalValue": 1000,
      "employeeCode": "texto",
      "agreementCode": "texto",
      "governmentDepartmentCode": "texto",
      "employeerInstCode": "texto",
      "governmentDepartmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "governmentDepartmentName": "Fulano de Tal",
      "warrantyCode": "texto",
      "paymentTransferDay": 0,
      "paymentAmountInCents": 0,
      "employmentStatusCode": "texto",
      "employmentStatusDescription": "texto",
      "previousAdeNumber": "texto",
      "warrantyDeadline": "2025-08-11T13:45:00Z",
      "warrantyOption": "texto",
      "warrantyOptionDisplay": "texto",
      "governmentDepartmentWarrantyStatus": "texto",
      "governmentDepartmentWarrantyStatusDisplay": "texto",
      "simulationRegistrationNumber": "texto",
      "payerName": "Fulano de Tal",
      "payerRegistrationNumber": "texto",
      "contractNumber": "texto",
      "invoiceNumber": "texto",
      "invoiceValue": 0,
      "discountValue": 0,
      "presentValue": 0,
      "dueDate": "2025-08-11T13:45:00Z",
      "paymentItemIndex": 0,
      "paymentItemTotal": 0,
      "yourNumber": "texto",
      "storeCode": 0,
      "productCode": 0,
      "creditType": "Duplicata_Mercantil",
      "identification": "texto",
      "emissionDate": "2025-08-11T13:45:00Z",
      "index": 0,
      "payerDescription": "NaturalPerson",
      "payerAdress": "texto",
      "payerZipCodeAdress": 0,
      "contractFee": 1000,
      "administratorName": "Fulano de Tal",
      "administratorRegistrationNumber": "texto",
      "quota": "texto",
      "group": "texto",
      "dataprev_EmployeeCode": "texto",
      "dataprev_EmployerRegistrationCode": 0,
      "dataprev_EmployerRegistrationNumber": "texto",
      "dataprev_EmployerName": "Fulano de Tal",
      "dataprev_DiscountStartPeriod": "texto",
      "dataprev_EmployeeAdmissionDate": "2025-08-11T13:45:00Z",
      "payingSourceRegistrationNumber": "texto",
      "payingSourceName": "Fulano de Tal",
      "dataprev_Status": "texto",
      "dataprev_StatusDisplay": "texto",
      "dataprev_OriginalMargin": 1000,
      "dataprev_AvailableMargin": 0,
      "dataprev_EmployeePositionCBOCode": 0,
      "dataprev_HasWarranty": true,
      "dataprev_WarrantyFgtsBalanceInCents": 0,
      "dataprev_WarrantyFgtsRescissionPenaltyInCents": 0,
      "dataprev_WarrantyRescissionBenefitPercentage": 1.99,
      "dataprev_CtpsDigitalAuthorizationNumber": "texto",
      "dataprev_ProposalNumber": "texto",
      "inss_RegistrationNumber": "texto",
      "inss_BenefitNumber": "texto",
      "inss_Name": "Fulano de Tal",
      "inss_BenefitType": "texto",
      "inss_BenefitTypeDescription": "texto",
      "inss_PaymentAccountType": "texto",
      "inss_PaymentAccountTypeDescription": "texto",
      "inss_PaymentBankCode": "texto",
      "inss_PaymentBankAgency": "texto",
      "inss_PaymentBankAccountNumber": "texto",
      "inss_AvailableMargin": 1000,
      "inss_OriginalMargin": 1000,
      "inss_MarginValue": 1000,
      "inss_MaximumInstallments": 0,
      "benefitCardMarginAmountInCents": 0,
      "benefitCardEmployeeCode": "texto",
      "benefitCardStartDate": "2025-08-11T13:45:00Z",
      "benefitCardWarrantyCode": "texto",
      "benefitCardCcbNumber": "texto",
      "benefitCardInstallmentValueInCents": 0,
      "ncm": "texto",
      "blNumber": "texto",
      "idInvoice": "texto",
      "valueBRL": 0,
      "policyNumber": "texto",
      "insuranceCompanyName": "Fulano de Tal",
      "insuranceCompanyCNPJ": "12345678000199",
      "inspectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "inspectionStatus": "texto",
      "inspectionStatusDisplay": "texto",
      "inspectionUpdatedAt": "2025-08-11T13:45:00Z"
    }
  ],
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "personRegistrationNumber": "texto",
  "customPaymentPlan": true,
  "personEmail": "cliente@exemplo.com.br",
  "personDisplay": "texto",
  "personDiscriminator": "texto",
  "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "beneficiaryRegistrationNumber": "texto",
  "beneficiaryEmail": "cliente@exemplo.com.br",
  "beneficiaryDisplay": "texto",
  "beneficiaryDiscriminator": "texto",
  "liquidationType": "texto",
  "liquidationTypeDisplay": "texto",
  "invoiceBarCode": "texto",
  "observations": "texto",
  "collateral": "texto",
  "invoiceValue": 0,
  "invoiceNumber": "texto",
  "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "changeBankAccount": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdAt": "2025-08-11T13:45:00Z",
    "createdBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenant": "texto",
      "tenantName": "Fulano de Tal"
    },
    "tenant": "texto",
    "tenantDisplay": "texto",
    "updatedAt": "2025-08-11T13:45:00Z",
    "updatedBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenant": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenant": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupDisplay": "texto",
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "bankCode": "texto",
    "bankCodeCompe": 0,
    "bankCodeDisplay": "texto",
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "texto",
    "typeDisplay": "texto",
    "jointAccount": true,
    "operationTypeValue": "texto",
    "pixKeyTypeValue": "texto",
    "keyPix": "texto"
  },
  "status": "texto",
  "statusDisplay": "texto",
  "statusValue": 0,
  "bankAccount": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdAt": "2025-08-11T13:45:00Z",
    "createdBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenant": "texto",
      "tenantName": "Fulano de Tal"
    },
    "tenant": "texto",
    "tenantDisplay": "texto",
    "updatedAt": "2025-08-11T13:45:00Z",
    "updatedBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenant": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenant": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupDisplay": "texto",
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "bankCode": "texto",
    "bankCodeCompe": 0,
    "bankCodeDisplay": "texto",
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "texto",
    "typeDisplay": "texto",
    "jointAccount": true,
    "operationTypeValue": "texto",
    "pixKeyTypeValue": "texto",
    "keyPix": "texto"
  },
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isRegistered": true,
  "bulkAssignment": true,
  "blockedUntil": "2025-08-11T13:45:00Z",
  "assignmentCalculation": {
    "amount": 1000,
    "type": "Absolute",
    "mode": "InitialValue"
  },
  "assignmentValue": 0,
  "assignmentDate": "2025-08-11T13:45:00Z",
  "assignmentCalculationResult": 0,
  "accruedInterest": 0,
  "issueNumber": 0,
  "emissionNumber": 0,
  "quantity": 0,
  "unitPrice": 0,
  "timeline": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2025-08-11T13:45:00Z",
      "createdBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "tenant": "texto",
      "tenantDisplay": "texto",
      "updatedAt": "2025-08-11T13:45:00Z",
      "updatedBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupDisplay": "texto",
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "index": 0,
      "name": "Fulano de Tal",
      "startedAt": "2025-08-11T13:45:00Z",
      "finishedAt": "2025-08-11T13:45:00Z",
      "description": "texto"
    }
  ],
  "assets": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2025-08-11T13:45:00Z",
      "createdBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "tenant": "texto",
      "tenantDisplay": "texto",
      "updatedAt": "2025-08-11T13:45:00Z",
      "updatedBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupDisplay": "texto",
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "assetType": "texto",
      "assetTypeDisplay": "texto",
      "description": "texto",
      "registerNumber": "texto",
      "estimatedValue": 1000,
      "settled": true
    }
  ],
  "relatedPersonCreditNote": [
    {
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "discriminator": "texto",
      "personIdDisplay": "texto",
      "typeOfRelationship": "texto",
      "typeOfRelationshipDisplay": "texto",
      "relatedToId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "relatedToDiscriminator": "texto",
      "relatedToIdDisplay": "texto",
      "signatureType": "texto",
      "signatureTypeDisplay": "texto",
      "signatureValidation": "texto",
      "signatureValidationDisplay": "texto",
      "percentage": 1.99,
      "isCreditBureauCheckSkipped": true
    }
  ],
  "uploads": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2025-08-11T13:45:00Z",
      "createdBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "tenant": "texto",
      "tenantDisplay": "texto",
      "updatedAt": "2025-08-11T13:45:00Z",
      "updatedBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupDisplay": "texto",
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "fileName": "Fulano de Tal",
      "fileType": "texto",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z",
      "tempUrl": "https://exemplo.com.br/callback",
      "tempGetUrl": "https://exemplo.com.br/callback",
      "tempPutUrl": "https://exemplo.com.br/callback"
    }
  ],
  "paymentScheduleItems": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dueDate": "2025-08-11T13:45:00Z",
      "principalAmountInCents": 0,
      "amortization": 0,
      "interest": 0,
      "financeTax": 0,
      "payment": 0,
      "accruedInterest": 0,
      "addedFixedCosts": 0,
      "paymentNo": 0
    }
  ],
  "unicoSignScore": 1000,
  "facialSimilarityScore": 1000,
  "signatureDetails": [
    {
      "registrationNumber": "12345678909",
      "userAgent": "texto",
      "ip": "texto",
      "geoLocation": "texto",
      "operationalSystem": "texto",
      "deviceModel": "texto",
      "deviceName": "Fulano de Tal",
      "deviceType": "texto",
      "smsValidation": true,
      "emailValidation": true
    }
  ],
  "codeIPOC": "texto",
  "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "transitoryBankAccount": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdAt": "2025-08-11T13:45:00Z",
    "createdBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenant": "texto",
      "tenantName": "Fulano de Tal"
    },
    "tenant": "texto",
    "tenantDisplay": "texto",
    "updatedAt": "2025-08-11T13:45:00Z",
    "updatedBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenant": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenant": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupDisplay": "texto",
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "bankCode": "texto",
    "bankCodeCompe": 0,
    "bankCodeDisplay": "texto",
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "texto",
    "typeDisplay": "texto",
    "jointAccount": true,
    "operationTypeValue": "texto",
    "pixKeyTypeValue": "texto",
    "keyPix": "texto"
  },
  "transitoryBankAccountOpenAccount": true,
  "liquidationSchedule": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "amountInCents": 0,
      "pixQrCode": {
        "qrCode": "texto"
      },
      "bankSlip": {
        "barcodeOrDigitableLine": "texto"
      },
      "pixKey": {
        "key": "texto",
        "pixKeyType": {},
        "typeDisplay": "texto"
      },
      "transfer": {
        "to": {},
        "type": {},
        "typeDisplay": "texto"
      },
      "description": "texto",
      "informedDueDate": "2025-08-11T13:45:00Z",
      "retrievedData": {
        "beneficiary": {},
        "bankslipData": {}
      },
      "type": "texto",
      "typeDisplay": "texto",
      "linkStatus": "texto",
      "linkStatusDisplay": "texto",
      "status": "texto",
      "statusDisplay": "texto",
      "paymentType": "texto",
      "paymentTypeDisplay": "texto",
      "failureMessage": "texto",
      "cosifAccountCode": "texto",
      "nsu": "texto"
    }
  ],
  "liquidationMode": "texto",
  "liquidationModeDisplay": "texto",
  "fgtscefProtocolNumber": "texto",
  "fgtscefProtocolDate": "2025-08-11T13:45:00Z",
  "batchSignatureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "liquidationClosureStatus": "texto",
  "liquidationClosureStatusDisplay": "texto",
  "creditNoteNoBase32": "texto",
  "installmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "personDetails": "texto",
  "insurance": true,
  "hasPersonDetailsDivergence": true,
  "scheduleEarliestDueDate": "2025-08-11T13:45:00Z",
  "isByxCreation": true
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### PUT /v{version}/CreditNote/{id}

**Atualiza os atributos da operação, incluindo envolvidos, uploads, etc** — Atualiza por completo um registro de Credit Note existente.

Atualiza os atributos da operação, incluindo envolvidos, uploads, etc. Permitido apenas quando o status da operação é Rascunho, Rejeitada, Revisão ou Erro.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |
| `returnValue` | query | `string` | opcional | — | `valor` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `productId` | `string (uuid)` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `amortization` | `objeto` | obrigatório | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `warranty` | `array de objeto` | opcional | Garantia de Bens | — | `[ … ]` |
| `emissionDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `personId` | `string (uuid)` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `beneficiaryId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `liquidationType` | `string` | opcional | — | `Invoice`, `EletronicTransfer` | `"Invoice"` |
| `invoiceBarCode` | `string` | opcional | — | — | `"texto"` |
| `collateral` | `string` | opcional | — | — | `"texto"` |
| `observations` | `string` | opcional | — | — | `"texto"` |
| `bankAccountId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `isRegistered` | `boolean` | opcional | — | — | `true` |
| `bulkAssignment` | `boolean` | opcional | — | — | `true` |
| `invoiceValue` | `integer (int64)` | opcional | — | — | `0` |
| `invoiceNumber` | `string` | opcional | — | — | `"texto"` |
| `changeBankAccountId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `issueNumber` | `integer` | opcional | Numero de série da nota comercial | — | `0` |
| `emissionNumber` | `integer` | opcional | Numero de emissão da nota comercial | — | `0` |
| `quantity` | `integer` | opcional | Quantidade de notas comerciais | — | `0` |
| `unitPrice` | `integer (int64)` | opcional | Valor unitario da nota comercial | — | `0` |
| `assignmentCalculation` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `assets` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `relatedPersonCreditNote` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `uploads` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `paymentScheduleItems` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `unicoSignScore` | `number (double)` | opcional | Score na Unico | — | `1000` |
| `facialSimilarityScore` | `number (double)` | opcional | Score na Unico | — | `1000` |
| `signatureDetails` | `array de objeto` | opcional | Detalhes da assinatura eletrônica | objeto — ver detalhe abaixo | `[ … ]` |
| `transitoryBankAccountId` | `string (uuid)` | opcional | Conta transitório do Roteiro de Liquidação | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `transitoryBankAccountOpenAccount` | `boolean` | opcional | — | — | `true` |
| `liquidationMode` | `string` | opcional | — | `Simple`, `LiquidationSchedule` | `"Simple"` |
| `liquidationSchedule` | `array de objeto` | opcional | Roteiro de liquidação | objeto — ver detalhe abaixo | `[ … ]` |
| `insurance` | `boolean` | opcional | Indica se a operação possui seguro | — | `true` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `groupId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `assignmentCalculation`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amount` | `number (double)` | opcional | — | — | `1000` |
| `type` | `string` | opcional | — | `Absolute`, `Percentage` | `"Absolute"` |
| `mode` | `string` | opcional | — | `InitialValue`, `PresentValuePayment`, `PresentValueCreditNote`, `Default` | `"InitialValue"` |

Detalhe de `assets`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Detalhe de `relatedPersonCreditNote`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `typeOfRelationship` | `string` | obrigatório | — | `Issuer`, `PartnerGuarantor`, `Guarantor`, `Proxy`, `ProxyGuarantor`, `Partner`, `Spouse`, `Consenter`, `Witness`, `Assignor`, `Assignee`, `Endorser`, `Employer`, `Creditor`, `Debtor`, `PartnerDebtor`, `BillingAgent`, `BillingAgentApproverUser`, `Beneficiary`, `NotaryAgent`, `SettlementAgent`, `CreditorEndorser`, `FaithfulCustodian`, `JointGuarantor`, `ThirdPartyGuarantor`, `LegalRepresentative`, `InsuranceCompany`, `Presidente`, `Administrador`, `Diretor` | `"Issuer"` |
| `relatedToId` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `signatureType` | `string` | opcional | — | `email`, `sms`, `whatsapp` | `"email"` |
| `signatureValidation` | `string` | opcional | — | `EletronicSignatureAndDocument`, `SelfieSignature`, `SelfieDocumentSignature`, `FacialBiometrics`, `DigitalCertificate`, `EletronicSignature` | `"EletronicSignatureAndDocument"` |
| `percentage` | `number (double)` | opcional | — | — | `1.99` |

Detalhe de `uploads`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | Id do arquivo | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `fileName` | `string` | obrigatório | Nome do arquivo (retornado pelo GET v1/Upload) | — | `"Fulano de Tal"` |
| `fileType` | `string` | opcional | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement`, `WarrantyRegistrationOfficeProof`, `OperationHistory`, `VehicleInspection`, `InsuranceCancellationTemplate`, `SignatureTemplateDraft`, `InssDefermentReport`, `InssMedicalReview` | `"Document"` |
| `displayName` | `string` | opcional | Nome de exibição do arquivo | — | `"Fulano de Tal"` |
| `documentDate` | `string (date-time)` | opcional | Data do próprio documento (emissão/referência), não a data do upload. Aceita em qualquer tipo de documento e sempre opcional. Só tem efeito de negócio no laudo de deferimento INSS e na última perícia INSS (regra de elegibilidade dos benefícios 32/92). | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `paymentScheduleItems`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `dueDate` | `string (date-time)` | opcional | Data de vencimento da parcela | — | `"2025-08-11T13:45:00Z"` |
| `principalAmountInCents` | `integer (int64)` | opcional | Saldo devedor da parcela após a apuração de amortização e juros | — | `0` |
| `amortization` | `integer (int64)` | opcional | Valor amortizado (principal) na parcela | — | `0` |
| `interest` | `integer (int64)` | opcional | Juros apurados no período | — | `0` |
| `financeTax` | `integer (int64)` | opcional | Valor de IOF que incide sob a parcela (IOF diário + parcela do IOF base) | — | `0` |
| `addedFixedCosts` | `integer (int64)` | opcional | Valor de tarifas adicionais que devem ser incluídas em cada parcela (valor não é financiado) | — | `0` |
| `payment` | `integer (int64)` | opcional | Valor da parcela que será pago pelo devedor no vencimento | — | `0` |

Detalhe de `signatureDetails`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `userAgent` | `string` | opcional | — | — | `"texto"` |
| `ip` | `string` | opcional | — | — | `"texto"` |
| `geoLocation` | `string` | opcional | — | — | `"texto"` |
| `operationalSystem` | `string` | opcional | — | — | `"texto"` |
| `deviceModel` | `string` | opcional | — | — | `"texto"` |
| `deviceName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `deviceType` | `string` | opcional | — | — | `"texto"` |
| `smsValidation` | `boolean` | opcional | — | — | `true` |
| `emailValidation` | `boolean` | opcional | — | — | `true` |

Detalhe de `liquidationSchedule`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amountInCents` | `integer (int64)` | obrigatório | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `pixQrCode`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `qrCode` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `bankSlip`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barcodeOrDigitableLine` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | obrigatório | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | obrigatório | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |

Detalhe de `to`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | obrigatório | — | — | `"12345678909"` |
| `bankCode` | `integer` | obrigatório | — | — | `0` |
| `bankIspb` | `integer (int64)` | obrigatório | — | — | `0` |
| `agency` | `string` | obrigatório | — | — | `"texto"` |
| `accountNumber` | `string` | obrigatório | — | — | `"texto"` |
| `accountType` | `string` | obrigatório | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |

Exemplo:

```json
{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amortization": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "amortizationType": "texto",
    "startDate": "2025-08-11T13:45:00Z",
    "apr": 1.99,
    "includePaymentFixedCosts": true,
    "validationErrors": [
      {
        "memberNames": [],
        "errorMessage": "texto"
      }
    ],
    "agentCommissions": [
      {
        "name": "Fulano de Tal",
        "amount": 1000,
        "type": {},
        "baseValue": {},
        "chargeCommissionFrom": {},
        "financeCost": true
      }
    ],
    "agentCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "type": "Absolute",
      "baseValue": "InitialValue",
      "chargeCommissionFrom": "All",
      "financeCost": true,
      "totalValue": 0
    }
  },
  "warranty": [
    {
      "warrantyType": "Warranty"
    }
  ],
  "emissionDate": "2025-08-11T13:45:00Z",
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "liquidationType": "Invoice",
  "invoiceBarCode": "texto",
  "collateral": "texto",
  "observations": "texto",
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isRegistered": true,
  "bulkAssignment": true,
  "invoiceValue": 0,
  "invoiceNumber": "texto",
  "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "issueNumber": 0,
  "emissionNumber": 0,
  "quantity": 0,
  "unitPrice": 0,
  "assignmentCalculation": {
    "amount": 1000,
    "type": "Absolute",
    "mode": "InitialValue"
  },
  "assets": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "relatedPersonCreditNote": [
    {
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "typeOfRelationship": "Issuer",
      "relatedToId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "signatureType": "email",
      "signatureValidation": "EletronicSignatureAndDocument",
      "percentage": 1.99
    }
  ],
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ],
  "paymentScheduleItems": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "dueDate": "2025-08-11T13:45:00Z",
      "principalAmountInCents": 0,
      "amortization": 0,
      "interest": 0,
      "financeTax": 0,
      "addedFixedCosts": 0,
      "payment": 0
    }
  ],
  "unicoSignScore": 1000,
  "facialSimilarityScore": 1000,
  "signatureDetails": [
    {
      "registrationNumber": "12345678909",
      "userAgent": "texto",
      "ip": "texto",
      "geoLocation": "texto",
      "operationalSystem": "texto",
      "deviceModel": "texto",
      "deviceName": "Fulano de Tal",
      "deviceType": "texto",
      "smsValidation": true,
      "emailValidation": true
    }
  ],
  "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "transitoryBankAccountOpenAccount": true,
  "liquidationMode": "Simple",
  "liquidationSchedule": [
    {
      "amountInCents": 0,
      "pixQrCode": {
        "qrCode": "texto"
      },
      "bankSlip": {
        "barcodeOrDigitableLine": "texto"
      },
      "pixKey": {
        "key": "texto",
        "pixKeyType": {},
        "typeDisplay": "texto"
      },
      "transfer": {
        "to": {},
        "type": {}
      },
      "description": "texto",
      "informedDueDate": "2025-08-11T13:45:00Z"
    }
  ],
  "insurance": true
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal"
  },
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amortization": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "amortizationType": "texto",
    "startDate": "2025-08-11T13:45:00Z",
    "apr": 1.99,
    "includePaymentFixedCosts": true,
    "validationErrors": [
      {
        "memberNames": [],
        "errorMessage": "texto"
      }
    ],
    "agentCommissions": [
      {
        "name": "Fulano de Tal",
        "amount": 1000,
        "type": {},
        "baseValue": {},
        "chargeCommissionFrom": {},
        "financeCost": true
      }
    ],
    "agentCommission": {
      "name": "Fulano de Tal",
      "amount": 1000,
      "type": "Absolute",
      "baseValue": "InitialValue",
      "chargeCommissionFrom": "All",
      "financeCost": true,
      "totalValue": 0
    }
  },
  "warranty": [
    {
      "warrantyType": "Warranty"
    }
  ],
  "emissionDate": "2025-08-11T13:45:00Z",
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "liquidationType": "Invoice",
  "invoiceBarCode": "texto",
  "collateral": "texto",
  "observations": "texto",
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isRegistered": true,
  "bulkAssignment": true,
  "invoiceValue": 0,
  "invoiceNumber": "texto",
  "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "issueNumber": 0,
  "emissionNumber": 0,
  "quantity": 0,
  "unitPrice": 0,
  "assignmentCalculation": {
    "amount": 1000,
    "type": "Absolute",
    "mode": "InitialValue"
  },
  "assets": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "relatedPersonCreditNote": [
    {
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "typeOfRelationship": "Issuer",
      "relatedToId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "signatureType": "email",
      "signatureValidation": "EletronicSignatureAndDocument",
      "percentage": 1.99
    }
  ],
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ],
  "paymentScheduleItems": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "dueDate": "2025-08-11T13:45:00Z",
      "principalAmountInCents": 0,
      "amortization": 0,
      "interest": 0,
      "financeTax": 0,
      "addedFixedCosts": 0,
      "payment": 0
    }
  ],
  "unicoSignScore": 1000,
  "facialSimilarityScore": 1000,
  "signatureDetails": [
    {
      "registrationNumber": "12345678909",
      "userAgent": "texto",
      "ip": "texto",
      "geoLocation": "texto",
      "operationalSystem": "texto",
      "deviceModel": "texto",
      "deviceName": "Fulano de Tal",
      "deviceType": "texto",
      "smsValidation": true,
      "emailValidation": true
    }
  ],
  "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "transitoryBankAccountOpenAccount": true,
  "liquidationMode": "Simple",
  "liquidationSchedule": [
    {
      "amountInCents": 0,
      "pixQrCode": {
        "qrCode": "texto"
      },
      "bankSlip": {
        "barcodeOrDigitableLine": "texto"
      },
      "pixKey": {
        "key": "texto",
        "pixKeyType": {},
        "typeDisplay": "texto"
      },
      "transfer": {
        "to": {},
        "type": {}
      },
      "description": "texto",
      "informedDueDate": "2025-08-11T13:45:00Z"
    }
  ],
  "insurance": true
}'
```

---

### DELETE /v{version}/CreditNote/{id}

**Exclui uma operação de crédito** — Remove um registro de Credit Note.

Exclui uma operação de crédito. Permitido apenas nos status Rascunho, Revisão, Rejeitado ou Cancelado

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### POST /v{version}/CreditNote/{id}/LiquidationSchedule

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amountInCents` | `integer (int64)` | obrigatório | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `pixQrCode`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `qrCode` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `bankSlip`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barcodeOrDigitableLine` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | obrigatório | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | obrigatório | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |

Detalhe de `to`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | obrigatório | — | — | `"12345678909"` |
| `bankCode` | `integer` | obrigatório | — | — | `0` |
| `bankIspb` | `integer (int64)` | obrigatório | — | — | `0` |
| `agency` | `string` | obrigatório | — | — | `"texto"` |
| `accountNumber` | `string` | obrigatório | — | — | `"texto"` |
| `accountType` | `string` | obrigatório | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |

Exemplo:

```json
{
  "amountInCents": 0,
  "pixQrCode": {
    "qrCode": "texto"
  },
  "bankSlip": {
    "barcodeOrDigitableLine": "texto"
  },
  "pixKey": {
    "key": "texto",
    "pixKeyType": "NaturalRegistrationNumber",
    "typeDisplay": "texto"
  },
  "transfer": {
    "to": {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bankCode": 0,
      "bankIspb": 0,
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "NaturalCheckingAccount"
    },
    "type": "Transfer"
  },
  "description": "texto",
  "informedDueDate": "2025-08-11T13:45:00Z"
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `amountInCents` | `integer (int64)` | opcional | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `retrievedData` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | opcional | — | — | `"texto"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |
| `linkStatus` | `string` | opcional | — | — | `"texto"` |
| `linkStatusDisplay` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | — | `"texto"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `paymentType` | `string` | opcional | — | — | `"texto"` |
| `paymentTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `failureMessage` | `string` | opcional | — | — | `"texto"` |
| `cosifAccountCode` | `string` | opcional | — | — | `"texto"` |
| `nsu` | `string` | opcional | — | — | `"texto"` |

Detalhe de `pixQrCode`:

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

Detalhe de `bankSlip`:

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

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | opcional | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | opcional | — | `Transfer`, `Pix` | `"Transfer"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `retrievedData`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `beneficiary` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankslipData` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `to`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `bankCodeDisplay` | `string` | opcional | — | — | `"texto"` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | — | `"texto"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `beneficiary`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bank` | `integer` | opcional | — | — | `0` |
| `bankCodeDisplay` | `string` | opcional | — | — | `"texto"` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | — | `"texto"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `bankslipData`:

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

Exemplo:

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amountInCents": 0,
  "pixQrCode": {
    "qrCode": "texto"
  },
  "bankSlip": {
    "barcodeOrDigitableLine": "texto"
  },
  "pixKey": {
    "key": "texto",
    "pixKeyType": "NaturalRegistrationNumber",
    "typeDisplay": "texto"
  },
  "transfer": {
    "to": {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bankCode": 0,
      "bankCodeDisplay": "texto",
      "bankIspb": 0,
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "texto",
      "accountTypeDisplay": "texto"
    },
    "type": "Transfer",
    "typeDisplay": "texto"
  },
  "description": "texto",
  "informedDueDate": "2025-08-11T13:45:00Z",
  "retrievedData": {
    "beneficiary": {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bank": 0,
      "bankCodeDisplay": "texto",
      "bankIspb": 0,
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "texto",
      "accountTypeDisplay": "texto"
    },
    "bankslipData": {
      "dueDate": "2025-08-11T13:45:00Z",
      "discount": 0,
      "paymentLimitDate": "2025-08-11T13:45:00Z"
    }
  },
  "type": "texto",
  "typeDisplay": "texto",
  "linkStatus": "texto",
  "linkStatusDisplay": "texto",
  "status": "texto",
  "statusDisplay": "texto",
  "paymentType": "texto",
  "paymentTypeDisplay": "texto",
  "failureMessage": "texto",
  "cosifAccountCode": "texto",
  "nsu": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/LiquidationSchedule" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "amountInCents": 0,
  "pixQrCode": {
    "qrCode": "texto"
  },
  "bankSlip": {
    "barcodeOrDigitableLine": "texto"
  },
  "pixKey": {
    "key": "texto",
    "pixKeyType": "NaturalRegistrationNumber",
    "typeDisplay": "texto"
  },
  "transfer": {
    "to": {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bankCode": 0,
      "bankIspb": 0,
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "NaturalCheckingAccount"
    },
    "type": "Transfer"
  },
  "description": "texto",
  "informedDueDate": "2025-08-11T13:45:00Z"
}'
```

---

### PUT /v{version}/CreditNote/{id}/LiquidationSchedule/{liquidationId}

**Atualizar Credit Note** — Atualiza por completo um registro de Credit Note existente.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `liquidationId` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amountInCents` | `integer (int64)` | obrigatório | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `pixQrCode`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `qrCode` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `bankSlip`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barcodeOrDigitableLine` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | obrigatório | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | obrigatório | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |

Detalhe de `to`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | obrigatório | — | — | `"12345678909"` |
| `bankCode` | `integer` | obrigatório | — | — | `0` |
| `bankIspb` | `integer (int64)` | obrigatório | — | — | `0` |
| `agency` | `string` | obrigatório | — | — | `"texto"` |
| `accountNumber` | `string` | obrigatório | — | — | `"texto"` |
| `accountType` | `string` | obrigatório | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |

Exemplo:

```json
{
  "amountInCents": 0,
  "pixQrCode": {
    "qrCode": "texto"
  },
  "bankSlip": {
    "barcodeOrDigitableLine": "texto"
  },
  "pixKey": {
    "key": "texto",
    "pixKeyType": "NaturalRegistrationNumber",
    "typeDisplay": "texto"
  },
  "transfer": {
    "to": {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bankCode": 0,
      "bankIspb": 0,
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "NaturalCheckingAccount"
    },
    "type": "Transfer"
  },
  "description": "texto",
  "informedDueDate": "2025-08-11T13:45:00Z"
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `amountInCents` | `integer (int64)` | opcional | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `retrievedData` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | opcional | — | — | `"texto"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |
| `linkStatus` | `string` | opcional | — | — | `"texto"` |
| `linkStatusDisplay` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | — | `"texto"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `paymentType` | `string` | opcional | — | — | `"texto"` |
| `paymentTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `failureMessage` | `string` | opcional | — | — | `"texto"` |
| `cosifAccountCode` | `string` | opcional | — | — | `"texto"` |
| `nsu` | `string` | opcional | — | — | `"texto"` |

Detalhe de `pixQrCode`:

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

Detalhe de `bankSlip`:

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

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | opcional | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | opcional | — | `Transfer`, `Pix` | `"Transfer"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `retrievedData`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `beneficiary` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankslipData` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `to`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `bankCodeDisplay` | `string` | opcional | — | — | `"texto"` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | — | `"texto"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `beneficiary`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bank` | `integer` | opcional | — | — | `0` |
| `bankCodeDisplay` | `string` | opcional | — | — | `"texto"` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | — | `"texto"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `bankslipData`:

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

Exemplo:

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amountInCents": 0,
  "pixQrCode": {
    "qrCode": "texto"
  },
  "bankSlip": {
    "barcodeOrDigitableLine": "texto"
  },
  "pixKey": {
    "key": "texto",
    "pixKeyType": "NaturalRegistrationNumber",
    "typeDisplay": "texto"
  },
  "transfer": {
    "to": {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bankCode": 0,
      "bankCodeDisplay": "texto",
      "bankIspb": 0,
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "texto",
      "accountTypeDisplay": "texto"
    },
    "type": "Transfer",
    "typeDisplay": "texto"
  },
  "description": "texto",
  "informedDueDate": "2025-08-11T13:45:00Z",
  "retrievedData": {
    "beneficiary": {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bank": 0,
      "bankCodeDisplay": "texto",
      "bankIspb": 0,
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "texto",
      "accountTypeDisplay": "texto"
    },
    "bankslipData": {
      "dueDate": "2025-08-11T13:45:00Z",
      "discount": 0,
      "paymentLimitDate": "2025-08-11T13:45:00Z"
    }
  },
  "type": "texto",
  "typeDisplay": "texto",
  "linkStatus": "texto",
  "linkStatusDisplay": "texto",
  "status": "texto",
  "statusDisplay": "texto",
  "paymentType": "texto",
  "paymentTypeDisplay": "texto",
  "failureMessage": "texto",
  "cosifAccountCode": "texto",
  "nsu": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/LiquidationSchedule/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "amountInCents": 0,
  "pixQrCode": {
    "qrCode": "texto"
  },
  "bankSlip": {
    "barcodeOrDigitableLine": "texto"
  },
  "pixKey": {
    "key": "texto",
    "pixKeyType": "NaturalRegistrationNumber",
    "typeDisplay": "texto"
  },
  "transfer": {
    "to": {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bankCode": 0,
      "bankIspb": 0,
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "NaturalCheckingAccount"
    },
    "type": "Transfer"
  },
  "description": "texto",
  "informedDueDate": "2025-08-11T13:45:00Z"
}'
```

---

### DELETE /v{version}/CreditNote/{id}/LiquidationSchedule/{liquidationId}

**Remover Credit Note** — Remove um registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `liquidationId` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### GET /v{version}/CreditNote/{id}/LiquidationScheduleCreditNote

**Listar Credit Note** — Lista e filtra registros de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |
| `linkStatus` | query | `string` | opcional | — | `valor` |
| `status` | query | `string` | opcional | — | `valor` |
| `page` | query | `integer` | opcional | — | `10` |
| `size` | query | `integer` | opcional | — | `10` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `page` | `integer` | opcional | — | — | `0` |
| `totalPages` | `integer` | opcional | — | — | `0` |
| `totalItems` | `integer` | opcional | — | — | `0` |
| `data` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `paginationToken` | `string` | opcional | — | — | `"texto"` |
| `totalValue` | `integer (int64)` | opcional | — | — | `0` |
| `totalAssignmentValue` | `integer (int64)` | opcional | — | — | `0` |

Detalhe de `data`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `amountInCents` | `integer (int64)` | opcional | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `retrievedData` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | opcional | — | — | `"texto"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |
| `linkStatus` | `string` | opcional | — | — | `"texto"` |
| `linkStatusDisplay` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | — | `"texto"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `paymentType` | `string` | opcional | — | — | `"texto"` |
| `paymentTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `failureMessage` | `string` | opcional | — | — | `"texto"` |
| `cosifAccountCode` | `string` | opcional | — | — | `"texto"` |
| `nsu` | `string` | opcional | — | — | `"texto"` |

Detalhe de `pixQrCode`:

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

Detalhe de `bankSlip`:

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

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | opcional | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | opcional | — | `Transfer`, `Pix` | `"Transfer"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `retrievedData`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `beneficiary` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankslipData` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `to`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `bankCodeDisplay` | `string` | opcional | — | — | `"texto"` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | — | `"texto"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `beneficiary`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bank` | `integer` | opcional | — | — | `0` |
| `bankCodeDisplay` | `string` | opcional | — | — | `"texto"` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | — | `"texto"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `bankslipData`:

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

Exemplo:

```json
{
  "page": 0,
  "totalPages": 0,
  "totalItems": 0,
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "amountInCents": 0,
      "pixQrCode": {
        "qrCode": "texto"
      },
      "bankSlip": {
        "barcodeOrDigitableLine": "texto"
      },
      "pixKey": {
        "key": "texto",
        "pixKeyType": {},
        "typeDisplay": "texto"
      },
      "transfer": {
        "to": {},
        "type": {},
        "typeDisplay": "texto"
      },
      "description": "texto",
      "informedDueDate": "2025-08-11T13:45:00Z",
      "retrievedData": {
        "beneficiary": {},
        "bankslipData": {}
      },
      "type": "texto",
      "typeDisplay": "texto",
      "linkStatus": "texto",
      "linkStatusDisplay": "texto",
      "status": "texto",
      "statusDisplay": "texto",
      "paymentType": "texto",
      "paymentTypeDisplay": "texto",
      "failureMessage": "texto",
      "cosifAccountCode": "texto",
      "nsu": "texto"
    }
  ],
  "paginationToken": "texto",
  "totalValue": 0,
  "totalAssignmentValue": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### GET /v{version}/CreditNote/{id}/LiquidationSchedule/{liquidationId}/Receipt

**Listar Credit Note** — Lista e filtra registros de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `liquidationId` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Resposta 200**

Exemplo:

```json
"texto"
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### GET /v{version}/CreditNote/{id}/GetPublicPayrollLoan

**Listar Credit Note** — Lista e filtra registros de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |
| `page` | query | `integer` | opcional | — | `10` |
| `size` | query | `integer` | opcional | — | `10` |
| `orderBy` | query | `string` | opcional | — | `valor` |
| `isDeleted` | query | `boolean` | opcional | — | `true` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `page` | `integer` | opcional | — | — | `0` |
| `totalPages` | `integer` | opcional | — | — | `0` |
| `totalItems` | `integer` | opcional | — | — | `0` |
| `data` | `array de objeto` | opcional | — | — | `[ … ]` |
| `paginationToken` | `string` | opcional | — | — | `"texto"` |
| `totalValue` | `integer (int64)` | opcional | — | — | `0` |
| `totalAssignmentValue` | `integer (int64)` | opcional | — | — | `0` |

Exemplo:

```json
{
  "page": 0,
  "totalPages": 0,
  "totalItems": 0,
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2025-08-11T13:45:00Z",
      "createdBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "tenant": "texto",
      "tenantDisplay": "texto",
      "updatedAt": "2025-08-11T13:45:00Z",
      "updatedBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupDisplay": "texto",
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "creditNoteNo": 0,
      "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "productIdDisplay": "texto",
      "productCategoryDisplay": "texto",
      "productInstrumentType": "texto",
      "acceptanceDate": "2025-08-11T13:45:00Z",
      "amortization": {
        "amortizationType": "texto",
        "calculateByValueType": "texto",
        "requestedAmount": 0,
        "principalAmountInCents": 0,
        "startDate": "2025-08-11T13:45:00Z",
        "termInMonths": 0,
        "numberOfPayments": 0,
        "paymentPeriodicity": {},
        "absAmortizationInMonths": 0,
        "absInterestInMonths": 0,
        "apr": 1.99,
        "periodicity": "texto",
        "daysInYear": 0,
        "agentCommission": {},
        "calculationType": "texto",
        "firstPaymentDate": "2025-08-11T13:45:00Z",
        "bankCommission": {},
        "financeOperationsTax": 1.99,
        "dailyFinanceOperationsTax": 1.99,
        "indexer": "texto",
        "indexerValue": 1000,
        "paymentDay": 0,
        "skippedMonths": [],
        "monthlyInterest": 1000,
        "yearlyInterest": 1000,
        "effectiveMonthlyCost": 1000,
        "effectiveYearlyCost": 1000,
        "liquidValue": 1,
        "comm": 0,
        "commTc": 0,
        "commNonTc": 0,
        "finTax": 0,
        "dueDate": "2025-08-11T13:45:00Z",
        "initialValue": 0,
        "fixedPaymentDuringGraduation": 0,
        "termsUntilGraduation": 0,
        "absAfterGraduation": 0,
        "pmt2Value": 1000,
        "fiduciaryGuarantee": 1000,
        "financeTaxExempted": true,
        "issueNumber": 0,
        "emissionNumber": 0,
        "quantity": 0,
        "unitPrice": 0,
        "minEmissionCost": 0,
        "maxEmissionCost": 0,
        "numberOfInterestPayments": 0,
        "valueMarginReserve": 0,
        "insuranceCoverAmount": 0,
        "paymentFixedCosts": 0,
        "includePaymentFixedCosts": true,
        "dueDateOnBusinessDays": true,
        "discountMode": true
      },
      "warranty": [
        {}
      ],
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "personRegistrationNumber": "texto",
      "customPaymentPlan": true,
      "personEmail": "cliente@exemplo.com.br",
      "personDisplay": "texto",
      "personDiscriminator": "texto",
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "beneficiaryRegistrationNumber": "texto",
      "beneficiaryEmail": "cliente@exemplo.com.br",
      "beneficiaryDisplay": "texto",
      "beneficiaryDiscriminator": "texto",
      "liquidationType": "texto",
      "liquidationTypeDisplay": "texto",
      "invoiceBarCode": "texto",
      "observations": "texto",
      "collateral": "texto",
      "invoiceValue": 0,
      "invoiceNumber": "texto",
      "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "changeBankAccount": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "tenant": "texto",
        "tenantDisplay": "texto",
        "updatedAt": "2025-08-11T13:45:00Z",
        "updatedBy": {},
        "ownerUser": {},
        "ownerGroup": {},
        "bankCode": "texto",
        "bankCodeCompe": 0,
        "bankCodeDisplay": "texto",
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": "texto",
        "typeDisplay": "texto",
        "jointAccount": true,
        "operationTypeValue": "texto",
        "pixKeyTypeValue": "texto",
        "keyPix": "texto"
      },
      "status": "texto",
      "statusDisplay": "texto",
      "statusValue": 0,
      "bankAccount": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "tenant": "texto",
        "tenantDisplay": "texto",
        "updatedAt": "2025-08-11T13:45:00Z",
        "updatedBy": {},
        "ownerUser": {},
        "ownerGroup": {},
        "bankCode": "texto",
        "bankCodeCompe": 0,
        "bankCodeDisplay": "texto",
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": "texto",
        "typeDisplay": "texto",
        "jointAccount": true,
        "operationTypeValue": "texto",
        "pixKeyTypeValue": "texto",
        "keyPix": "texto"
      },
      "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "isRegistered": true,
      "bulkAssignment": true,
      "blockedUntil": "2025-08-11T13:45:00Z",
      "assignmentCalculation": {
        "amount": 1000,
        "type": {},
        "mode": {}
      },
      "assignmentValue": 0,
      "assignmentDate": "2025-08-11T13:45:00Z",
      "assignmentCalculationResult": 0,
      "accruedInterest": 0,
      "issueNumber": 0,
      "emissionNumber": 0,
      "quantity": 0,
      "unitPrice": 0,
      "timeline": [
        {}
      ],
      "assets": [
        {}
      ],
      "relatedPersonCreditNote": [
        {}
      ],
      "uploads": [
        {}
      ],
      "paymentScheduleItems": [
        {}
      ],
      "unicoSignScore": 1000,
      "facialSimilarityScore": 1000,
      "signatureDetails": [
        {}
      ],
      "codeIPOC": "texto",
      "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "transitoryBankAccount": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "tenant": "texto",
        "tenantDisplay": "texto",
        "updatedAt": "2025-08-11T13:45:00Z",
        "updatedBy": {},
        "ownerUser": {},
        "ownerGroup": {},
        "bankCode": "texto",
        "bankCodeCompe": 0,
        "bankCodeDisplay": "texto",
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": "texto",
        "typeDisplay": "texto",
        "jointAccount": true,
        "operationTypeValue": "texto",
        "pixKeyTypeValue": "texto",
        "keyPix": "texto"
      },
      "transitoryBankAccountOpenAccount": true,
      "liquidationSchedule": [
        {}
      ],
      "liquidationMode": "texto",
      "liquidationModeDisplay": "texto",
      "fgtscefProtocolNumber": "texto",
      "fgtscefProtocolDate": "2025-08-11T13:45:00Z",
      "batchSignatureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "liquidationClosureStatus": "texto",
      "liquidationClosureStatusDisplay": "texto",
      "creditNoteNoBase32": "texto",
      "installmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "personDetails": "texto",
      "insurance": true,
      "hasPersonDetailsDivergence": true,
      "scheduleEarliestDueDate": "2025-08-11T13:45:00Z",
      "isByxCreation": true
    }
  ],
  "paginationToken": "texto",
  "totalValue": 0,
  "totalAssignmentValue": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### GET /v1/CreditNote

**[v1] Lista operações de crédito recebendo cada filtro como parâmetro de query…** — Lista e filtra registros de Credit Note.

[v1] Lista operações de crédito recebendo cada filtro como parâmetro de query individual.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `page` | query | `integer` | opcional | — | `10` |
| `size` | query | `integer` | opcional | — | `10` |
| `searchString` | query | `string` | opcional | — | `valor` |
| `status` | query | `array de string` | opcional | — | `valor` |
| `creditNoteNo` | query | `integer` | opcional | — | `10` |
| `personId` | query | `string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `personDisplay` | query | `string` | opcional | — | `valor` |
| `initialDate` | query | `string (date-time)` | opcional | — | `valor` |
| `finalDate` | query | `string (date-time)` | opcional | — | `valor` |
| `initialPaymentDate` | query | `string (date-time)` | opcional | — | `valor` |
| `finalPaymentDate` | query | `string (date-time)` | opcional | — | `valor` |
| `isDeleted` | query | `boolean` | opcional | — | `true` |
| `orderBy` | query | `string` | opcional | — | `valor` |
| `minValue` | query | `integer (int64)` | opcional | — | `10` |
| `maxValue` | query | `integer (int64)` | opcional | — | `10` |
| `filterByOwner` | query | `string` | opcional | — | `valor` |
| `filterByOwnerGroup` | query | `string` | opcional | — | `valor` |
| `assigned` | query | `boolean` | opcional | — | `true` |
| `productCategoryDisplay` | query | `string` | opcional | — | `valor` |
| `relatedPersons` | query | `array de string` | opcional | — | `valor` |
| `ownLiquidation` | query | `boolean` | opcional | — | `true` |
| `ownCompliance` | query | `boolean` | opcional | — | `true` |
| `liquidationMode` | query | `string` | opcional | — | `valor` |
| `productId` | query | `string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `onlyShared` | query | `boolean` | opcional | — | `true` |
| `closureStatus` | query | `string` | opcional | — | `valor` |
| `liquidationModeList` | query | `array de string` | opcional | — | `valor` |
| `productCategoryDisplayList` | query | `array de string` | opcional | — | `valor` |
| `productIdList` | query | `array de string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `personIdList` | query | `array de string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `filterByOwnerGroupList` | query | `array de string` | opcional | — | `valor` |
| `filterByCorbanList` | query | `array de string` | opcional | — | `valor` |
| `minimumInterestRate` | query | `number (double)` | opcional | — | `100.00` |
| `maximumInterestRate` | query | `number (double)` | opcional | — | `100.00` |
| `minOpApr` | query | `number (double)` | opcional | — | `100.00` |
| `maxOpApr` | query | `number (double)` | opcional | — | `100.00` |
| `filterByObservations` | query | `string` | opcional | — | `valor` |
| `insurance` | query | `boolean` | opcional | — | `true` |
| `initialScheduleDueDate` | query | `string (date-time)` | opcional | — | `valor` |
| `finalScheduleDueDate` | query | `string (date-time)` | opcional | — | `valor` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `page` | `integer` | opcional | — | — | `0` |
| `totalPages` | `integer` | opcional | — | — | `0` |
| `totalItems` | `integer` | opcional | — | — | `0` |
| `data` | `array de objeto` | opcional | — | — | `[ … ]` |
| `paginationToken` | `string` | opcional | — | — | `"texto"` |
| `totalValue` | `integer (int64)` | opcional | — | — | `0` |
| `totalAssignmentValue` | `integer (int64)` | opcional | — | — | `0` |

Exemplo:

```json
{
  "page": 0,
  "totalPages": 0,
  "totalItems": 0,
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2025-08-11T13:45:00Z",
      "createdBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "tenant": "texto",
      "tenantDisplay": "texto",
      "updatedAt": "2025-08-11T13:45:00Z",
      "updatedBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupDisplay": "texto",
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "creditNoteNo": 0,
      "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "productIdDisplay": "texto",
      "productCategoryDisplay": "texto",
      "productInstrumentType": "texto",
      "acceptanceDate": "2025-08-11T13:45:00Z",
      "amortization": {
        "amortizationType": "texto",
        "calculateByValueType": "texto",
        "requestedAmount": 0,
        "principalAmountInCents": 0,
        "startDate": "2025-08-11T13:45:00Z",
        "termInMonths": 0,
        "numberOfPayments": 0,
        "paymentPeriodicity": {},
        "absAmortizationInMonths": 0,
        "absInterestInMonths": 0,
        "apr": 1.99,
        "periodicity": "texto",
        "daysInYear": 0,
        "agentCommission": {},
        "calculationType": "texto",
        "firstPaymentDate": "2025-08-11T13:45:00Z",
        "bankCommission": {},
        "financeOperationsTax": 1.99,
        "dailyFinanceOperationsTax": 1.99,
        "indexer": "texto",
        "indexerValue": 1000,
        "paymentDay": 0,
        "skippedMonths": [],
        "monthlyInterest": 1000,
        "yearlyInterest": 1000,
        "effectiveMonthlyCost": 1000,
        "effectiveYearlyCost": 1000,
        "liquidValue": 1,
        "comm": 0,
        "commTc": 0,
        "commNonTc": 0,
        "finTax": 0,
        "dueDate": "2025-08-11T13:45:00Z",
        "initialValue": 0,
        "fixedPaymentDuringGraduation": 0,
        "termsUntilGraduation": 0,
        "absAfterGraduation": 0,
        "pmt2Value": 1000,
        "fiduciaryGuarantee": 1000,
        "financeTaxExempted": true,
        "issueNumber": 0,
        "emissionNumber": 0,
        "quantity": 0,
        "unitPrice": 0,
        "minEmissionCost": 0,
        "maxEmissionCost": 0,
        "numberOfInterestPayments": 0,
        "valueMarginReserve": 0,
        "insuranceCoverAmount": 0,
        "paymentFixedCosts": 0,
        "includePaymentFixedCosts": true,
        "dueDateOnBusinessDays": true,
        "discountMode": true
      },
      "warranty": [
        {}
      ],
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "personRegistrationNumber": "texto",
      "customPaymentPlan": true,
      "personEmail": "cliente@exemplo.com.br",
      "personDisplay": "texto",
      "personDiscriminator": "texto",
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "beneficiaryRegistrationNumber": "texto",
      "beneficiaryEmail": "cliente@exemplo.com.br",
      "beneficiaryDisplay": "texto",
      "beneficiaryDiscriminator": "texto",
      "liquidationType": "texto",
      "liquidationTypeDisplay": "texto",
      "invoiceBarCode": "texto",
      "observations": "texto",
      "collateral": "texto",
      "invoiceValue": 0,
      "invoiceNumber": "texto",
      "changeBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "changeBankAccount": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "tenant": "texto",
        "tenantDisplay": "texto",
        "updatedAt": "2025-08-11T13:45:00Z",
        "updatedBy": {},
        "ownerUser": {},
        "ownerGroup": {},
        "bankCode": "texto",
        "bankCodeCompe": 0,
        "bankCodeDisplay": "texto",
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": "texto",
        "typeDisplay": "texto",
        "jointAccount": true,
        "operationTypeValue": "texto",
        "pixKeyTypeValue": "texto",
        "keyPix": "texto"
      },
      "status": "texto",
      "statusDisplay": "texto",
      "statusValue": 0,
      "bankAccount": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "tenant": "texto",
        "tenantDisplay": "texto",
        "updatedAt": "2025-08-11T13:45:00Z",
        "updatedBy": {},
        "ownerUser": {},
        "ownerGroup": {},
        "bankCode": "texto",
        "bankCodeCompe": 0,
        "bankCodeDisplay": "texto",
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": "texto",
        "typeDisplay": "texto",
        "jointAccount": true,
        "operationTypeValue": "texto",
        "pixKeyTypeValue": "texto",
        "keyPix": "texto"
      },
      "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "isRegistered": true,
      "bulkAssignment": true,
      "blockedUntil": "2025-08-11T13:45:00Z",
      "assignmentCalculation": {
        "amount": 1000,
        "type": {},
        "mode": {}
      },
      "assignmentValue": 0,
      "assignmentDate": "2025-08-11T13:45:00Z",
      "assignmentCalculationResult": 0,
      "accruedInterest": 0,
      "issueNumber": 0,
      "emissionNumber": 0,
      "quantity": 0,
      "unitPrice": 0,
      "timeline": [
        {}
      ],
      "assets": [
        {}
      ],
      "relatedPersonCreditNote": [
        {}
      ],
      "uploads": [
        {}
      ],
      "paymentScheduleItems": [
        {}
      ],
      "unicoSignScore": 1000,
      "facialSimilarityScore": 1000,
      "signatureDetails": [
        {}
      ],
      "codeIPOC": "texto",
      "transitoryBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "transitoryBankAccount": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "tenant": "texto",
        "tenantDisplay": "texto",
        "updatedAt": "2025-08-11T13:45:00Z",
        "updatedBy": {},
        "ownerUser": {},
        "ownerGroup": {},
        "bankCode": "texto",
        "bankCodeCompe": 0,
        "bankCodeDisplay": "texto",
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": "texto",
        "typeDisplay": "texto",
        "jointAccount": true,
        "operationTypeValue": "texto",
        "pixKeyTypeValue": "texto",
        "keyPix": "texto"
      },
      "transitoryBankAccountOpenAccount": true,
      "liquidationSchedule": [
        {}
      ],
      "liquidationMode": "texto",
      "liquidationModeDisplay": "texto",
      "fgtscefProtocolNumber": "texto",
      "fgtscefProtocolDate": "2025-08-11T13:45:00Z",
      "batchSignatureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "liquidationClosureStatus": "texto",
      "liquidationClosureStatusDisplay": "texto",
      "creditNoteNoBase32": "texto",
      "installmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "personDetails": "texto",
      "insurance": true,
      "hasPersonDetailsDivergence": true,
      "scheduleEarliestDueDate": "2025-08-11T13:45:00Z",
      "isByxCreation": true
    }
  ],
  "paginationToken": "texto",
  "totalValue": 0,
  "totalAssignmentValue": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### GET /v1/CreditNote/related-operations

**Lista enxuta de operações relacionáveis para a picklist de "operação relacionada"…** — Lista e filtra registros de Credit Note.

Lista enxuta de operações relacionáveis para a picklist de "operação relacionada" na Compra de Dívida.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `personId` | query | `string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `creditNoteNo` | query | `integer` | opcional | — | `10` |
| `excludeId` | query | `string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `page` | query | `integer` | opcional | — | `10` |
| `size` | query | `integer` | opcional | — | `10` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `page` | `integer` | opcional | — | — | `0` |
| `totalPages` | `integer` | opcional | — | — | `0` |
| `totalItems` | `integer` | opcional | — | — | `0` |
| `data` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `paginationToken` | `string` | opcional | — | — | `"texto"` |
| `totalValue` | `integer (int64)` | opcional | — | — | `0` |
| `totalAssignmentValue` | `integer (int64)` | opcional | — | — | `0` |

Detalhe de `data`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `creditNoteNo` | `integer` | opcional | — | — | `0` |
| `productDisplay` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | `Draft`, `ComplianceApproval`, `Signatures`, `Liquidation`, `Finished`, `Disapproved`, `Error`, `Revision`, `CreditApproval`, `InstrumentApproval`, `Canceled`, `WaitLiquidation`, `SignaturesValidation`, `PaymentRevision`, `ManualLiquidation`, `Warranty`, `ManualWarranty`, `MarginReserveApproval`, `WarrantyRevision`, `PartnerSignaturesValidation`, `OpenAccountRevision`, `VehicleInspection`, `VehicleInspectionApproval`, `GravameRegistration` | `"Draft"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
{
  "page": 0,
  "totalPages": 0,
  "totalItems": 0,
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "creditNoteNo": 0,
      "productDisplay": "texto",
      "status": "Draft",
      "statusDisplay": "texto",
      "createdAt": "2025-08-11T13:45:00Z"
    }
  ],
  "paginationToken": "texto",
  "totalValue": 0,
  "totalAssignmentValue": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/v1/CreditNote/related-operations" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v{version}/CreditNote/Export/excel

**Exporta operações de crédito em formato Excel com base nos filtros informados** — Lista e filtra registros de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `version` | path | `string` | obrigatório | — | `1` |
| `CreditNoteNo` | query | `integer` | opcional | — | `10` |
| `SearchString` | query | `string` | opcional | — | `valor` |
| `PersonId` | query | `string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `PersonDisplay` | query | `string` | opcional | — | `valor` |
| `InitialDate` | query | `string (date-time)` | opcional | — | `valor` |
| `FinalDate` | query | `string (date-time)` | opcional | — | `valor` |
| `InitialPaymentDate` | query | `string (date-time)` | opcional | — | `valor` |
| `FinalPaymentDate` | query | `string (date-time)` | opcional | — | `valor` |
| `IsDeleted` | query | `boolean` | opcional | — | `true` |
| `MinValue` | query | `integer (int64)` | opcional | — | `10` |
| `MaxValue` | query | `integer (int64)` | opcional | — | `10` |
| `FilterByOwner` | query | `string` | opcional | — | `valor` |
| `FilterByOwnerGroup` | query | `string` | opcional | — | `valor` |
| `ProductCategoryDisplay` | query | `string` | opcional | — | `valor` |
| `RelatedPersons` | query | `array de string` | opcional | — | `valor` |
| `Status` | query | `array de string` | opcional | — | `valor` |
| `Assigned` | query | `boolean` | opcional | — | `true` |
| `OwnLiquidation` | query | `boolean` | opcional | — | `true` |
| `OwnCompliance` | query | `boolean` | opcional | — | `true` |
| `OnlyShared` | query | `boolean` | opcional | — | `true` |
| `LiquidationMode` | query | `string` | opcional | — | `valor` |
| `ProductId` | query | `string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `ClosureStatus` | query | `string` | opcional | — | `valor` |
| `LiquidationModeList` | query | `array de string` | opcional | — | `valor` |
| `ProductCategoryDisplayList` | query | `array de string` | opcional | — | `valor` |
| `ProductIdList` | query | `array de string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `PersonIdList` | query | `array de string (uuid)` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `FilterByOwnerGroupList` | query | `array de string` | opcional | — | `valor` |
| `FilterByCorbanList` | query | `array de string` | opcional | — | `valor` |
| `MinimumInterestRate` | query | `number (double)` | opcional | — | `100.00` |
| `MaximumInterestRate` | query | `number (double)` | opcional | — | `100.00` |
| `MinOpApr` | query | `number (double)` | opcional | — | `100.00` |
| `MaxOpApr` | query | `number (double)` | opcional | — | `100.00` |
| `FilterByObservations` | query | `string` | opcional | — | `valor` |
| `Insurance` | query | `boolean` | opcional | — | `true` |
| `InitialScheduleDueDate` | query | `string (date-time)` | opcional | — | `valor` |
| `FinalScheduleDueDate` | query | `string (date-time)` | opcional | — | `valor` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/v1/CreditNote/Export/excel" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v{version}/CreditNote/{id}/SignatureDetails

**Obtém os detalhes da assinatura da operação** — Lista e filtra registros de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | Id da operação de crédito | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `signatureDetails` | `array de objeto` | opcional | Detalhes da assinatura eletrônica coletada pelo parceiro | objeto — ver detalhe abaixo | `[ … ]` |
| `unicoSignScore` | `number (double)` | opcional | Score na Unico | — | `1000` |
| `facialSimilarityScore` | `number (double)` | opcional | Score de similaridade facial na Unico Cloud | — | `1000` |

Detalhe de `signatureDetails`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `userAgent` | `string` | opcional | — | — | `"texto"` |
| `ip` | `string` | opcional | — | — | `"texto"` |
| `geoLocation` | `string` | opcional | — | — | `"texto"` |
| `operationalSystem` | `string` | opcional | — | — | `"texto"` |
| `deviceModel` | `string` | opcional | — | — | `"texto"` |
| `deviceName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `deviceType` | `string` | opcional | — | — | `"texto"` |
| `smsValidation` | `boolean` | opcional | — | — | `true` |
| `emailValidation` | `boolean` | opcional | — | — | `true` |

Exemplo:

```json
{
  "signatureDetails": [
    {
      "registrationNumber": "12345678909",
      "userAgent": "texto",
      "ip": "texto",
      "geoLocation": "texto",
      "operationalSystem": "texto",
      "deviceModel": "texto",
      "deviceName": "Fulano de Tal",
      "deviceType": "texto",
      "smsValidation": true,
      "emailValidation": true
    }
  ],
  "unicoSignScore": 1000,
  "facialSimilarityScore": 1000
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |
| `401` | Não autenticado — token ausente, inválido ou expirado. |
| `403` | Autenticado, mas sem permissão para o recurso. |
| `404` | Recurso não encontrado. |

**cURL**

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

---

### PUT /v{version}/CreditNote/{id}/SignatureDetails

**Atualiza os detalhes da assinatura da operação** — Atualiza por completo um registro de Credit Note existente.

Atualiza os detalhes da assinatura da operação. Permitido quando o status é Rascunho, Revisão ou Assinaturas.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | Id da operação de crédito | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `signatureDetails` | `array de objeto` | opcional | Detalhes da assinatura eletrônica | objeto — ver detalhe abaixo | `[ … ]` |
| `unicoSignScore` | `number (double)` | opcional | Score na Unico | — | `1000` |
| `facialSimilarityScore` | `number (double)` | opcional | Score de similaridade facial na Unico Cloud | — | `1000` |

Detalhe de `signatureDetails`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `userAgent` | `string` | opcional | — | — | `"texto"` |
| `ip` | `string` | opcional | — | — | `"texto"` |
| `geoLocation` | `string` | opcional | — | — | `"texto"` |
| `operationalSystem` | `string` | opcional | — | — | `"texto"` |
| `deviceModel` | `string` | opcional | — | — | `"texto"` |
| `deviceName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `deviceType` | `string` | opcional | — | — | `"texto"` |
| `smsValidation` | `boolean` | opcional | — | — | `true` |
| `emailValidation` | `boolean` | opcional | — | — | `true` |

Exemplo:

```json
{
  "signatureDetails": [
    {
      "registrationNumber": "12345678909",
      "userAgent": "texto",
      "ip": "texto",
      "geoLocation": "texto",
      "operationalSystem": "texto",
      "deviceModel": "texto",
      "deviceName": "Fulano de Tal",
      "deviceType": "texto",
      "smsValidation": true,
      "emailValidation": true
    }
  ],
  "unicoSignScore": 1000,
  "facialSimilarityScore": 1000
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `204` | Sucesso sem corpo de resposta. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |
| `401` | Não autenticado — token ausente, inválido ou expirado. |
| `403` | Autenticado, mas sem permissão para o recurso. |
| `404` | Recurso não encontrado. |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/SignatureDetails" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "signatureDetails": [
    {
      "registrationNumber": "12345678909",
      "userAgent": "texto",
      "ip": "texto",
      "geoLocation": "texto",
      "operationalSystem": "texto",
      "deviceModel": "texto",
      "deviceName": "Fulano de Tal",
      "deviceType": "texto",
      "smsValidation": true,
      "emailValidation": true
    }
  ],
  "unicoSignScore": 1000,
  "facialSimilarityScore": 1000
}'
```

---

### POST /v{version}/CreditNote/{id}/draftpreview

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |
| `useWatermark` | query | `boolean` | opcional | — | `true` |
| `createPdf` | query | `boolean` | opcional | — | `true` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### POST /v{version}/CreditNote/{id}/LiquidationScheduleClosureUpdateStatus

**Atualiza o status de fechamento do roteiro de liquidacao** — Cria um novo registro de Credit Note.

Atualiza o status de fechamento do roteiro de liquidacao. Somente operacoes do tipo Roteiro de Liquidacao, encerradas e nao deletadas podem executar esse endpoint.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `liquidationClosureStatus` | `string` | obrigatório | — | `Pending`, `SettleOperation`, `TransferChangeAccount`, `TransitoryBankAccountClosed`, `Revision`, `Cancelled`, `Finished` | `"Pending"` |
| `reason` | `string` | obrigatório | — | — | `"texto"` |

Exemplo:

```json
{
  "liquidationClosureStatus": "Pending",
  "reason": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/LiquidationScheduleClosureUpdateStatus" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "liquidationClosureStatus": "Pending",
  "reason": "texto"
}'
```

---

### POST /v{version}/CreditNote/{id}/submitapproval

**Envia a operação para aprovação** — Cria um novo registro de Credit Note.

Envia a operação para aprovação. Após o envio, a mesma não poderá ser alterada até o término da análise.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |
| `updateStartDate` | query | `boolean` | opcional | — | `true` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### POST /v{version}/CreditNote/{id}/donePaymentRevision

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `bankAccount` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `changeBankAccount` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `bankAccount`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `bankIspb` | `integer (int64)` | opcional | Código ISPB do banco | — | `0` |
| `account` | `string` | opcional | — | — | `"texto"` |
| `accountDigit` | `string` | opcional | — | — | `"texto"` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `agencyDigit` | `string` | opcional | — | — | `"texto"` |
| `type` | `string` | opcional | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |
| `jointAccount` | `boolean` | opcional | — | — | `true` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `keyPix` | `string` | opcional | Chave Pix | — | `"texto"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `groupId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Exemplo:

```json
{
  "bankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  },
  "changeBankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  }
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/donePaymentRevision" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "bankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  },
  "changeBankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  }
}'
```

---

### POST /v{version}/CreditNote/{id}/doneWarrantyRevision

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `warrantyIds` | `array de string (uuid)` | opcional | IDs das garantias que serão removidas do processo averbação | — | `[ … ]` |
| `reason` | `string` | opcional | Motivo da alteração das garantias | — | `"texto"` |
| `warrantyOfficeTokens` | `array de objeto` | opcional | Lista de tokens de averbação | objeto — ver detalhe abaixo | `[ … ]` |
| `observations` | `string` | opcional | Observação | — | `"texto"` |

Detalhe de `warrantyOfficeTokens`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `warrantyRegistrationOffice` | `string` | opcional | — | `None`, `Fgts`, `Zetra`, `Siape`, `Others`, `DataPrevCreditoTrabalhador`, `SemearInss`, `CarEquity` | `"None"` |
| `token` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `warrantyCode` | `string` | opcional | Código de garantia | — | `"texto"` |
| `expirationDate` | `string (date-time)` | opcional | Data expiração | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `token`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `tokenType` | `string` | opcional | — | `Reserve`, `NestEgg`, `Warranty` | `"Reserve"` |
| `tokenValue` | `string` | opcional | Valor do Token | — | `"texto"` |

Exemplo:

```json
{
  "warrantyIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "reason": "texto",
  "warrantyOfficeTokens": [
    {
      "warrantyRegistrationOffice": "None",
      "token": {
        "tokenType": {},
        "tokenValue": "texto"
      },
      "warrantyCode": "texto",
      "expirationDate": "2025-08-11T13:45:00Z"
    }
  ],
  "observations": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/doneWarrantyRevision" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "warrantyIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "reason": "texto",
  "warrantyOfficeTokens": [
    {
      "warrantyRegistrationOffice": "None",
      "token": {
        "tokenType": {},
        "tokenValue": "texto"
      },
      "warrantyCode": "texto",
      "expirationDate": "2025-08-11T13:45:00Z"
    }
  ],
  "observations": "texto"
}'
```

---

### POST /v{version}/CreditNote/{id}/disapproveWarrantyRevision

**Reprova a Revisão de Garantia de uma operação CarEquity: finaliza a operação em** — Cria um novo registro de Credit Note.

Reprova a Revisão de Garantia de uma operação CarEquity: finaliza a operação em Reprovado (sem liquidar). Diferente de "concluir" (que reenvia para nova averbação) e de "cancelar" (status Cancelada). O tratamento é feito pela sub-orquestração {opId}VETERA.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### POST /v{version}/CreditNote/{id}/paymentRevisionLiquidationSchedule

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `liquidationScheduleItems` | `array de objeto` | obrigatório | Itens do 'Roteiro de Liquidação' que serão alterados/adiconados | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `liquidationScheduleItems`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `liquidationScheduleId` | `string (uuid)` | opcional | Id do LiquidationSchedule, preencher em caso de edição | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `liquidationSchedule` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `liquidationSchedule`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amountInCents` | `integer (int64)` | obrigatório | — | — | `0` |
| `pixQrCode` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `bankSlip` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `transfer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `informedDueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `pixQrCode`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `qrCode` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `bankSlip`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barcodeOrDigitableLine` | `string` | obrigatório | — | — | `"texto"` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `key` | `string` | obrigatório | — | — | `"texto"` |
| `pixKeyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transfer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `to` | `objeto` | obrigatório | — | objeto — ver detalhe abaixo | `{ … }` |
| `type` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |

Detalhe de `to`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | obrigatório | — | — | `"12345678909"` |
| `bankCode` | `integer` | obrigatório | — | — | `0` |
| `bankIspb` | `integer (int64)` | obrigatório | — | — | `0` |
| `agency` | `string` | obrigatório | — | — | `"texto"` |
| `accountNumber` | `string` | obrigatório | — | — | `"texto"` |
| `accountType` | `string` | obrigatório | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |

Exemplo:

```json
{
  "liquidationScheduleItems": [
    {
      "liquidationScheduleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "liquidationSchedule": {
        "amountInCents": 0,
        "pixQrCode": {},
        "bankSlip": {},
        "pixKey": {},
        "transfer": {},
        "description": "texto",
        "informedDueDate": "2025-08-11T13:45:00Z"
      }
    }
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/paymentRevisionLiquidationSchedule" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "liquidationScheduleItems": [
    {
      "liquidationScheduleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "liquidationSchedule": {
        "amountInCents": 0,
        "pixQrCode": {},
        "bankSlip": {},
        "pixKey": {},
        "transfer": {},
        "description": "texto",
        "informedDueDate": "2025-08-11T13:45:00Z"
      }
    }
  ]
}'
```

---

### POST /v{version}/CreditNote/{id}/liquidationScheduleClosureRevision

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `changeBankAccount` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `changeBankAccount`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerUser` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `id` | `string (uuid)` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `bankIspb` | `integer (int64)` | opcional | Código ISPB do banco | — | `0` |
| `account` | `string` | opcional | — | — | `"texto"` |
| `accountDigit` | `string` | opcional | — | — | `"texto"` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `agencyDigit` | `string` | opcional | — | — | `"texto"` |
| `type` | `string` | opcional | — | `NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount` | `"NaturalCheckingAccount"` |
| `jointAccount` | `boolean` | opcional | — | — | `true` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `keyPix` | `string` | opcional | Chave Pix | — | `"texto"` |

Detalhe de `ownerUser`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Detalhe de `ownerGroup`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `groupId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |

Exemplo:

```json
{
  "changeBankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  }
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/liquidationScheduleClosureRevision" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "changeBankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  }
}'
```

---

### POST /v{version}/CreditNote/{id}/cancel

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |
| `checkAverbacao` | query | `boolean` | opcional | — | `true` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `message` | `string` | opcional | — | — | `"texto"` |
| `insertBlock` | `string` | opcional | — | `Person`, `Operation` | `"Person"` |
| `blockUntil` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `attributeTypes` | `array de string` | opcional | — | `zipcode`, `email`, `phone`, `documentnumber`, `ispb`, `registrationnumber` | `[ … ]` |
| `rejectionReasonCode` | `array de string` | opcional | — | — | `[ … ]` |

Exemplo:

```json
{
  "message": "texto",
  "insertBlock": "Person",
  "blockUntil": "2025-08-11T13:45:00Z",
  "attributeTypes": [
    "zipcode"
  ],
  "rejectionReasonCode": [
    "texto"
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/cancel" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "message": "texto",
  "insertBlock": "Person",
  "blockUntil": "2025-08-11T13:45:00Z",
  "attributeTypes": [
    "zipcode"
  ],
  "rejectionReasonCode": [
    "texto"
  ]
}'
```

---

### POST /v{version}/CreditNote/batch/cancel

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `version` | path | `string` | obrigatório | — | `1` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `creditNoteIds` | `array de string (uuid)` | opcional | — | — | `[ … ]` |
| `message` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `checkAverbacao` | `boolean` | opcional | — | — | `true` |

Detalhe de `message`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `message` | `string` | opcional | — | — | `"texto"` |
| `insertBlock` | `string` | opcional | — | `Person`, `Operation` | `"Person"` |
| `blockUntil` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `attributeTypes` | `array de string` | opcional | — | `zipcode`, `email`, `phone`, `documentnumber`, `ispb`, `registrationnumber` | `[ … ]` |
| `rejectionReasonCode` | `array de string` | opcional | — | — | `[ … ]` |

Exemplo:

```json
{
  "creditNoteIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "message": {
    "message": "texto",
    "insertBlock": "Person",
    "blockUntil": "2025-08-11T13:45:00Z",
    "attributeTypes": [
      "zipcode"
    ],
    "rejectionReasonCode": [
      "texto"
    ]
  },
  "checkAverbacao": true
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/batch/cancel" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "creditNoteIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "message": {
    "message": "texto",
    "insertBlock": "Person",
    "blockUntil": "2025-08-11T13:45:00Z",
    "attributeTypes": [
      "zipcode"
    ],
    "rejectionReasonCode": [
      "texto"
    ]
  },
  "checkAverbacao": true
}'
```

---

### GET /v{version}/CreditNote/{id}/transferReceipt

**Obtém o recibo de transferência relacionada à operação** — Lista e filtra registros de Credit Note.

Obtém o recibo de transferência relacionada à operação.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### POST /v{version}/CreditNote/{id}/restore

**Restaura Operação de Crédito excluída** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### GET /v{version}/CreditNote/{id}/SignUrl

**Obtém as URLs de assinaturas relacionadas à operação** — Lista e filtra registros de Credit Note.

Obtém as URLs de assinaturas relacionadas à operação.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `creditNoteId` | `string (uuid)` | opcional | Id da operação de crédito | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `personId` | `string (uuid)` | opcional | Id do tomador da operação de crédito | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `personCellPhone` | `string` | opcional | Telefone celular do tomador | — | `"11987654321"` |
| `personEmail` | `string` | opcional | Email do tomador | — | `"cliente@exemplo.com.br"` |
| `url` | `string` | opcional | Link de assinatura do contrato | — | `"https://exemplo.com.br/callback"` |
| `createdAt` | `string (date-time)` | opcional | Data de criação do link | — | `"2025-08-11T13:45:00Z"` |
| `displayName` | `string` | opcional | Nome do tomador da operação | — | `"Fulano de Tal"` |

Exemplo:

```json
[
  {
    "creditNoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "personCellPhone": "11987654321",
    "personEmail": "cliente@exemplo.com.br",
    "url": "https://exemplo.com.br/callback",
    "createdAt": "2025-08-11T13:45:00Z",
    "displayName": "Fulano de Tal"
  }
]
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### POST /v{version}/CreditNote/{id}/Installment

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

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

Campos:

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

Exemplo:

```json
{
  "walletCode": 0,
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/Installment" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "walletCode": 0,
  "billingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
```

---

### POST /v{version}/CreditNote/{id}/Share

**Criar Credit Note** — Cria um novo registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string (uuid)` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `version` | path | `string` | obrigatório | — | `1` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `principalType` | `string` | opcional | — | `User`, `Group`, `Tenant`, `Application` | `"User"` |
| `principalId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `permissionLevel` | `string` | opcional | — | `View`, `Edit` | `"View"` |

Exemplo:

```json
{
  "principalType": "User",
  "principalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "permissionLevel": "View"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/Share" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "principalType": "User",
  "principalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "permissionLevel": "View"
}'
```

---

### PATCH /v{version}/CreditNote/FixDueDate

**Atualizar Credit Note** — Atualiza parcialmente um registro de Credit Note.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `version` | path | `string` | obrigatório | — | `1` |

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

Exemplo:

```json
[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X PATCH "{{baseUrl}}/v1/CreditNote/FixDueDate" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
]'
```

---