Lista enxuta de operações relacionáveis para a picklist de "operação relacionada"…

Lista e filtra registros de Credit Note.

Visão geral

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

Retorna apenas operações em <b>Rascunho</b> do mesmo tomador (personId), com projeção
leve (número, produto, status). A busca por creditNoteNo é exata e
excludeId remove a operação atual do resultado.

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

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`

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"`
`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` +10	`"Draft"`
`statusDisplay`	`string`	opcional	—	—	`"texto"`
`createdAt`	`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",
      "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	Detalhe do contrato
`200`	Requisição bem-sucedida.	Success

Exemplos

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/related-operations";

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