Criar Credit Note

Cria um novo registro de Credit Note.

Visão geral

Cria um novo registro 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.

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`version`	path	`string`	obrigatório	—	`1`

Corpo da requisição

Envie no formato application/json. Corpo opcional.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`creditNoteIds`	`array de string (uuid)`	opcional	—	—	`[ … ]`
`message`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`checkAverbacao`	`boolean`	opcional	—	—	`true`

Detalhe de `message`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`message`	`string`	opcional	—	—	`"texto"`
`insertBlock`	`string`	opcional	—	`Person`, `Operation`	`"Person"`
`blockUntil`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`attributeTypes`	`array de string`	opcional	—	`zipcode`, `email`, `phone`, `documentnumber`, `ispb`, `registrationnumber`	`[ … ]`
`rejectionReasonCode`	`array de string`	opcional	—	—	`[ … ]`

Exemplo de corpo

{
  "creditNoteIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "message": {
    "message": "texto",
    "insertBlock": "Person",
    "blockUntil": "2025-08-11T13:45:00Z",
    "attributeTypes": [
      "zipcode"
    ],
    "rejectionReasonCode": [
      "texto"
    ]
  },
  "checkAverbacao": true
}

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 POST "{{baseUrl}}/v1/CreditNote/batch/cancel" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "creditNoteIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "message": {
    "message": "texto",
    "insertBlock": "Person",
    "blockUntil": "2025-08-11T13:45:00Z",
    "attributeTypes": [
      "zipcode"
    ],
    "rejectionReasonCode": [
      "texto"
    ]
  },
  "checkAverbacao": true
}'

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/batch/cancel";

var corpo = new StringContent(
    """
    {
      "creditNoteIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "message": {
        "message": "texto",
        "insertBlock": "Person",
        "blockUntil": "2025-08-11T13:45:00Z",
        "attributeTypes": [
          "zipcode"
        ],
        "rejectionReasonCode": [
          "texto"
        ]
      },
      "checkAverbacao": true
    }
    """,
    Encoding.UTF8, "application/json");

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

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

const payload = {
  "creditNoteIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "message": {
    "message": "texto",
    "insertBlock": "Person",
    "blockUntil": "2025-08-11T13:45:00Z",
    "attributeTypes": [
      "zipcode"
    ],
    "rejectionReasonCode": [
      "texto"
    ]
  },
  "checkAverbacao": true
};

const resp = await fetch(`${baseUrl}/v1/CreditNote/batch/cancel`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(payload),
});

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