Listar Credit Note

Lista e filtra registros de Credit Note.

Visão geral

Lista e filtra registros de Credit Note.

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`
`page`	query	`integer`	opcional	—	`10`
`size`	query	`integer`	opcional	—	`10`
`orderBy`	query	`string`	opcional	—	`valor`
`isDeleted`	query	`boolean`	opcional	—	`true`

Corpo da requisição

Este endpoint não recebe corpo.

Response

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 de resposta

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

Exemplos

curl -X GET "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/GetPublicPayrollLoan" \
  -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/GetPublicPayrollLoan";

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/GetPublicPayrollLoan`, {
  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