Exporta operações de crédito em formato Excel com base nos filtros informados

Lista e filtra registros de Credit Note.

Visão geral

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
`version`	path	`string`	obrigatório	—	`1`
`CreditNoteNo`	query	`integer`	opcional	—	`10`
`SearchString`	query	`string`	opcional	—	`valor`
`PersonId`	query	`string (uuid)`	opcional	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`PersonDisplay`	query	`string`	opcional	—	`valor`
`InitialDate`	query	`string (date-time)`	opcional	—	`valor`
`FinalDate`	query	`string (date-time)`	opcional	—	`valor`
`InitialPaymentDate`	query	`string (date-time)`	opcional	—	`valor`
`FinalPaymentDate`	query	`string (date-time)`	opcional	—	`valor`
`IsDeleted`	query	`boolean`	opcional	—	`true`
`MinValue`	query	`integer (int64)`	opcional	—	`10`
`MaxValue`	query	`integer (int64)`	opcional	—	`10`
`FilterByOwner`	query	`string`	opcional	—	`valor`
`FilterByOwnerGroup`	query	`string`	opcional	—	`valor`
`ProductCategoryDisplay`	query	`string`	opcional	—	`valor`
`RelatedPersons`	query	`array de string`	opcional	—	`valor`
`Status`	query	`array de string`	opcional	—	`valor`
`Assigned`	query	`boolean`	opcional	—	`true`
`OwnLiquidation`	query	`boolean`	opcional	—	`true`
`OwnCompliance`	query	`boolean`	opcional	—	`true`
`OnlyShared`	query	`boolean`	opcional	—	`true`
`LiquidationMode`	query	`string`	opcional	—	`valor`
`ProductId`	query	`string (uuid)`	opcional	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`ClosureStatus`	query	`string`	opcional	—	`valor`
`LiquidationModeList`	query	`array de string`	opcional	—	`valor`
`ProductCategoryDisplayList`	query	`array de string`	opcional	—	`valor`
`ProductIdList`	query	`array de string (uuid)`	opcional	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`PersonIdList`	query	`array de string (uuid)`	opcional	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`FilterByOwnerGroupList`	query	`array de string`	opcional	—	`valor`
`FilterByCorbanList`	query	`array de string`	opcional	—	`valor`
`MinimumInterestRate`	query	`number (double)`	opcional	—	`100.00`
`MaximumInterestRate`	query	`number (double)`	opcional	—	`100.00`
`MinOpApr`	query	`number (double)`	opcional	—	`100.00`
`MaxOpApr`	query	`number (double)`	opcional	—	`100.00`
`FilterByObservations`	query	`string`	opcional	—	`valor`
`Insurance`	query	`boolean`	opcional	—	`true`
`InitialScheduleDueDate`	query	`string (date-time)`	opcional	—	`valor`
`FinalScheduleDueDate`	query	`string (date-time)`	opcional	—	`valor`

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200 sem corpo (Success).

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	Success

Exemplos

curl -X GET "{{baseUrl}}/v1/CreditNote/Export/excel" \
  -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/Export/excel";

var resp = await http.GetAsync(rota);
resp.EnsureSuccessStatusCode();
// Sem corpo de resposta neste endpoint.

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

const resp = await fetch(`${baseUrl}/v1/CreditNote/Export/excel`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

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