API Docs Início Documentação Referência de API Copiar para LLM
POST/v{version}/CreditNote
Crédito · Operação de crédito

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

Cria um novo registro de Credit Note.

Visão geral

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

Autenticação e pré-requisitos

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

Request

Parâmetros

NomeEmTipoObrigatórioDescriçãoExemplo
versionpathstringobrigatório—1
updateStartDatequerybooleanopcional—true
returnValuequerystringopcional—valor

Corpo da requisição

Envie no formato application/json. Corpo opcional.

Campos

CampoTipoObrigatórioDescriçãoValoresExemplo
ownerUserobjetoopcional—objeto — ver detalhe abaixo{ … }
ownerGroupobjetoopcional—objeto — ver detalhe abaixo{ … }
productIdstring (uuid)obrigatórioproduto contratado—"3fa85f64-5717-4562-b3fc-2c963f66afa6"
warrantyarray de objetoopcionalGarantia de Bens—[ … ]
emissionDatestring (date-time)opcionalData de emissão do contrato—"2025-08-11T13:45:00Z"
amortizationobjetoobrigatórioParâmetros da operaçãovaria conforme o tipo — ver exemplo{ … }
personIdstring (uuid)obrigatórioPessoa tomadora—"3fa85f64-5717-4562-b3fc-2c963f66afa6"
liquidationTypestringopcional—Invoice, EletronicTransfer"Invoice"
invoiceBarCodestringopcionalLinha digitável, para quando o tipo de liquidação é por boleto—"texto"
beneficiaryIdstring (uuid)opcionalBenefiário da operação—"3fa85f64-5717-4562-b3fc-2c963f66afa6"
collateralstringopcionalDados da garantia da operação—"texto"
observationsstringopcionalObservações gerais sobre a operação que poderão ser levadas em consideração pela mesa—"texto"
statusstringopcional—Draft, ComplianceApproval, Signatures, Liquidation, Finished, Disapproved, Error, Revision, CreditApproval, InstrumentApproval, Canceled, WaitLiquidation, SignaturesValidation, PaymentRevision +10"Draft"
bankAccountIdstring (uuid)opcionalConta bancária—"3fa85f64-5717-4562-b3fc-2c963f66afa6"
isRegisteredbooleanopcionalIndica se há registro em uma Registradora de Recebíveis—true
bulkAssignmentbooleanopcionalIndica se terá cessão em lote—true
invoiceValueinteger (int64)opcionalValor em centavos da nota fiscal—0
invoiceNumberstringopcionalNúmero da nota fiscal (44 dígitos)—"texto"
changeBankAccountIdstring (uuid)opcionalConta bancária de troco—"3fa85f64-5717-4562-b3fc-2c963f66afa6"
issueNumberintegeropcionalNumero de série da nota comercial—0
emissionNumberintegeropcionalNumero de emissão da nota comercial—0
quantityintegeropcionalQuantidade de notas comerciais—0
unitPriceinteger (int64)opcionalValor unitario da nota comercial—0
assignmentCalculationobjetoopcional—objeto — ver detalhe abaixo{ … }
assetsarray de objetoopcionalLista de IDs das garantias vinculadas à operação. São bens/diretos da(s) PFs ou PJs vinculadas à operaçãoobjeto — ver detalhe abaixo[ … ]
relatedPersonCreditNotearray de objetoopcionalLista das pessoas relacionadas a operação.objeto — ver detalhe abaixo[ … ]
uploadsarray de objetoopcionalLista de arquivos relacionadas a operação.objeto — ver detalhe abaixo[ … ]
paymentScheduleItemsarray de objetoopcionalLista de parcelas relacionadas a operação.objeto — ver detalhe abaixo[ … ]
unicoSignScorenumber (double)opcionalScore na Unico—1000
facialSimilarityScorenumber (double)opcionalScore na Unico—1000
transitoryBankAccountIdstring (uuid)opcionalConta transitório do Roteiro de Liquidação—"3fa85f64-5717-4562-b3fc-2c963f66afa6"
transitoryBankAccountOpenAccountbooleanopcional——true
liquidationModestringopcional—Simple, LiquidationSchedule"Simple"
liquidationSchedulearray de objetoopcionalRoteiro de liquidaçãoobjeto — ver detalhe abaixo[ … ]
signatureDetailsarray de objetoopcionalDados da assinatura eletrônica de envolvidosobjeto — ver detalhe abaixo[ … ]
newPersonAndAccountobjetoopcional—objeto — ver detalhe abaixo{ … }
insurancebooleanopcionalIndica se a operação possui seguro—true
dataprevOfferCTPSRequestIdinteger (int64)opcionalRequestId da oferta CTPS de origem (espelho de DataprevEmployeeOfferCTPS.RequestId). Informado apenas quando a operação é criada a partir do leilão. Default null.—1
isByxCreationbooleanopcionalFlag para indicar se a operação foi enviada pela BYX—true

Detalhe de ownerUser

CampoTipoObrigatórioDescriçãoValoresExemplo
userIdstringobrigatório——"3fa85f64-5717-4562-b3fc-2c963f66afa6"
tenantNamestringobrigatório——"Fulano de Tal"

Detalhe de ownerGroup

CampoTipoObrigatórioDescriçãoValoresExemplo
groupIdstringobrigatório——"3fa85f64-5717-4562-b3fc-2c963f66afa6"
tenantNamestringobrigatório——"Fulano de Tal"

Detalhe de assignmentCalculation

CampoTipoObrigatórioDescriçãoValoresExemplo
amountnumber (double)opcional——1000
typestringopcional—Absolute, Percentage"Absolute"
modestringopcional—InitialValue, PresentValuePayment, PresentValueCreditNote, Default"InitialValue"

Detalhe de assets

CampoTipoObrigatórioDescriçãoValoresExemplo
idstring (uuid)opcional——"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Detalhe de relatedPersonCreditNote

CampoTipoObrigatórioDescriçãoValoresExemplo
personIdstring (uuid)opcional——"3fa85f64-5717-4562-b3fc-2c963f66afa6"
typeOfRelationshipstringobrigatório—Issuer, PartnerGuarantor, Guarantor, Proxy, ProxyGuarantor, Partner, Spouse, Consenter, Witness, Assignor, Assignee, Endorser, Employer, Creditor +16"Issuer"
relatedToIdstring (uuid)opcional——"3fa85f64-5717-4562-b3fc-2c963f66afa6"
signatureTypestringopcional—email, sms, whatsapp"email"
signatureValidationstringopcional—EletronicSignatureAndDocument, SelfieSignature, SelfieDocumentSignature, FacialBiometrics, DigitalCertificate, EletronicSignature"EletronicSignatureAndDocument"
percentagenumber (double)opcional——1.99

Detalhe de uploads

CampoTipoObrigatórioDescriçãoValoresExemplo
ownerUserobjetoopcional—objeto — ver detalhe abaixo{ … }
ownerGroupobjetoopcional—objeto — ver detalhe abaixo{ … }
fileTypestringobrigatório—Document, Authorization, DriversLicense, WorkCard, ResidenceProofCompany, ResidenceProofPartners, Draft, SocialContract, RegistrationNumber, IdentificationDocumentWithPhoto, BankStatement, ManagerialBilling, RegistrationForm, Others +41"Document"
fileNamestringobrigatórioNome do arquivo (retornado pelo GET v1/Upload)—"Fulano de Tal"
displayNamestringopcionalNome de exibição do arquivo—"Fulano de Tal"
documentDatestring (date-time)opcionalData 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

CampoTipoObrigatórioDescriçãoValoresExemplo
ownerUserobjetoopcional—objeto — ver detalhe abaixo{ … }
ownerGroupobjetoopcional—objeto — ver detalhe abaixo{ … }
dueDatestring (date-time)opcionalData de vencimento da parcela—"2025-08-11T13:45:00Z"
principalAmountInCentsinteger (int64)opcionalSaldo devedor da parcela após a apuração de amortização e juros—0
amortizationinteger (int64)opcionalValor amortizado (principal) na parcela—0
interestinteger (int64)opcionalJuros apurados no período—0
financeTaxinteger (int64)opcionalValor de IOF que incide sob a parcela (IOF diário + parcela do IOF base)—0
addedFixedCostsinteger (int64)opcionalValor de tarifas adicionais que devem ser incluídas em cada parcela (valor não é financiado)—0
paymentinteger (int64)opcionalValor da parcela que será pago pelo devedor no vencimento—0

Detalhe de liquidationSchedule

CampoTipoObrigatórioDescriçãoValoresExemplo
amountInCentsinteger (int64)obrigatório——0
pixQrCodeobjetoopcional—objeto — ver detalhe abaixo{ … }
bankSlipobjetoopcional—objeto — ver detalhe abaixo{ … }
pixKeyobjetoopcional—objeto — ver detalhe abaixo{ … }
transferobjetoopcional—objeto — ver detalhe abaixo{ … }
descriptionstringopcional——"texto"
informedDueDatestring (date-time)opcional——"2025-08-11T13:45:00Z"

Detalhe de signatureDetails

CampoTipoObrigatórioDescriçãoValoresExemplo
registrationNumberstringopcional——"12345678909"
userAgentstringopcional——"texto"
ipstringopcional——"texto"
geoLocationstringopcional——"texto"
operationalSystemstringopcional——"texto"
deviceModelstringopcional——"texto"
deviceNamestringopcional——"Fulano de Tal"
deviceTypestringopcional——"texto"
smsValidationbooleanopcional——true
emailValidationbooleanopcional——true

Detalhe de newPersonAndAccount

CampoTipoObrigatórioDescriçãoValoresExemplo
personTypestringopcional—Natural, Legal"Natural"
listBankAccountsarray de objetoopcional—objeto — ver detalhe abaixo[ … ]

Detalhe de pixQrCode

CampoTipoObrigatórioDescriçãoValoresExemplo
qrCodestringobrigatório——"texto"

Detalhe de bankSlip

CampoTipoObrigatórioDescriçãoValoresExemplo
barcodeOrDigitableLinestringobrigatório——"texto"

Detalhe de pixKey

CampoTipoObrigatórioDescriçãoValoresExemplo
keystringobrigatório——"texto"
pixKeyTypestringopcional—NaturalRegistrationNumber, LegalRegistrationNumber, Phone, Email, Automatic, AgencyAndAccount"NaturalRegistrationNumber"
typeDisplaystringopcional——"texto"

Detalhe de transfer

CampoTipoObrigatórioDescriçãoValoresExemplo
toobjetoobrigatório—objeto — ver detalhe abaixo{ … }
typestringobrigatório—Transfer, Pix"Transfer"

Detalhe de listBankAccounts

CampoTipoObrigatórioDescriçãoValoresExemplo
ownerUserobjetoopcional—objeto — ver detalhe abaixo{ … }
ownerGroupobjetoopcional—objeto — ver detalhe abaixo{ … }
bankCodeintegeropcional——0
bankIspbinteger (int64)opcionalCódigo ISPB do banco—0
accountstringopcional——"texto"
accountDigitstringopcional——"texto"
agencystringopcional——"texto"
agencyDigitstringopcional——"texto"
typestringopcional—NaturalCheckingAccount, NaturalSimpleAccount, LegalCheckingAccount, PublicEntities, FinancialInstitutionsDeposits, NaturalSavingsAccount, LegalSavingsAccount, RealEstateSavingsAccount, LotteryDeposits, EscrowAccount"NaturalCheckingAccount"
jointAccountbooleanopcional——true
operationTypeValuestringobrigatório—Transfer, Pix"Transfer"
pixKeyTypeValuestringopcional—NaturalRegistrationNumber, LegalRegistrationNumber, Phone, Email, Automatic, AgencyAndAccount"NaturalRegistrationNumber"
keyPixstringopcionalchave pix—"texto"

Exemplo de corpo

{
  "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
}

Response

Resposta 200 sem corpo (Success).

Códigos de retorno

CódigoSignificadoDetalhe do contrato
200Requisição bem-sucedida.Success

Exemplos

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
}'
var baseUrl = "{{baseUrl}}";
var token   = "{{token}}";

using var http = new HttpClient { BaseAddress = new Uri(baseUrl) };
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", token);

var rota = "/v1/CreditNote";

var corpo = new StringContent(
    """
    {
      "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
    }
    """,
    Encoding.UTF8, "application/json");

var resp = await http.PostAsync(rota, corpo);
resp.EnsureSuccessStatusCode();
// Sem corpo de resposta neste endpoint.
const baseUrl = '{{baseUrl}}';
const token   = '{{token}}';

const payload = {
  "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
};

const resp = await fetch(`${baseUrl}/v1/CreditNote`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(payload),
});

if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
// Sem corpo de resposta neste endpoint.

Troque apenas {{baseUrl}} e {{token}}. No Postman, defina-os como variáveis de environment; o cURL importa em Import > Raw text.

Downloads

Este endpoint já vem configurado nas collections abaixo, na pasta da etapa correspondente.

Collection completaConsignado privado e FGTS, em pastas espelhando a documentação.Baixar →Collection do Consignado privadoCadastros, operação e consultas do módulo.Baixar →Collection do FGTSCadastros, operação e consultas do módulo.Baixar →Environment do PostmanAs variáveis fora da collection, para versionar uma sem versionar o token.Baixar →Documentação consolidada para LLMToda a documentação em um arquivo de texto, na ordem da navegação.Baixar →Referência em MarkdownEste contrato, campo a campo, gerado do spec.Baixar →

Guia de importação: Como importar no Postman · Todos os downloads: Downloads