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

Consulta Credit Note pelo identificador informado na rota.

Visão geral

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

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.

Pré-requisitos: a rota exige identificador(es) de recurso já existente(s):

id — —

Request

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

Este endpoint não recebe corpo.

Response

Resposta 200.

Sem campos estruturados no contrato (tipo primitivo ou livre).

Exemplo de resposta

{
  "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	Detalhe do contrato
`200`	Requisição bem-sucedida.	Success

Exemplos

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

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/3fa85f64-5717-4562-b3fc-2c963f66afa6";

var resp = await http.GetAsync(rota);
resp.EnsureSuccessStatusCode();
var json = await resp.Content.ReadAsStringAsync();

const baseUrl = '{{baseUrl}}';
const token   = '{{token}}';

const resp = await fetch(`${baseUrl}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
const data = await resp.json();

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