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

Crédito · Operação de crédito

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`
`linkStatus`	query	`string`	opcional	—	`valor`
`status`	query	`string`	opcional	—	`valor`
`page`	query	`integer`	opcional	—	`10`
`size`	query	`integer`	opcional	—	`10`

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

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

Exemplos

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

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

Visão geral

Autenticação e pré-requisitos

Request

Parâmetros

Corpo da requisição

Response

Campos

Detalhe de data

Detalhe de pixQrCode

Detalhe de bankSlip

Detalhe de pixKey

Detalhe de transfer

Detalhe de retrievedData

Detalhe de to

Detalhe de beneficiary

Detalhe de bankslipData