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.

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`

Corpo da requisição

Envie no formato application/json. Corpo opcional.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`warrantyIds`	`array de string (uuid)`	opcional	IDs das garantias que serão removidas do processo averbação	—	`[ … ]`
`reason`	`string`	opcional	Motivo da alteração das garantias	—	`"texto"`
`warrantyOfficeTokens`	`array de objeto`	opcional	Lista de tokens de averbação	objeto — ver detalhe abaixo	`[ … ]`
`observations`	`string`	opcional	Observação	—	`"texto"`

Detalhe de `warrantyOfficeTokens`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`warrantyRegistrationOffice`	`string`	opcional	—	`None`, `Fgts`, `Zetra`, `Siape`, `Others`, `DataPrevCreditoTrabalhador`, `SemearInss`, `CarEquity`	`"None"`
`token`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`warrantyCode`	`string`	opcional	Código de garantia	—	`"texto"`
`expirationDate`	`string (date-time)`	opcional	Data expiração	—	`"2025-08-11T13:45:00Z"`

Detalhe de `token`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`tokenType`	`string`	opcional	—	`Reserve`, `NestEgg`, `Warranty`	`"Reserve"`
`tokenValue`	`string`	opcional	Valor do Token	—	`"texto"`

Exemplo de corpo

{
  "warrantyIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "reason": "texto",
  "warrantyOfficeTokens": [
    {
      "warrantyRegistrationOffice": "None",
      "token": {
        "tokenType": {},
        "tokenValue": "texto"
      },
      "warrantyCode": "texto",
      "expirationDate": "2025-08-11T13:45:00Z"
    }
  ],
  "observations": "texto"
}

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/3fa85f64-5717-4562-b3fc-2c963f66afa6/doneWarrantyRevision" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "warrantyIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "reason": "texto",
  "warrantyOfficeTokens": [
    {
      "warrantyRegistrationOffice": "None",
      "token": {
        "tokenType": {},
        "tokenValue": "texto"
      },
      "warrantyCode": "texto",
      "expirationDate": "2025-08-11T13:45:00Z"
    }
  ],
  "observations": "texto"
}'

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/doneWarrantyRevision";

var corpo = new StringContent(
    """
    {
      "warrantyIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "reason": "texto",
      "warrantyOfficeTokens": [
        {
          "warrantyRegistrationOffice": "None",
          "token": {
            "tokenType": {},
            "tokenValue": "texto"
          },
          "warrantyCode": "texto",
          "expirationDate": "2025-08-11T13:45:00Z"
        }
      ],
      "observations": "texto"
    }
    """,
    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 = {
  "warrantyIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "reason": "texto",
  "warrantyOfficeTokens": [
    {
      "warrantyRegistrationOffice": "None",
      "token": {
        "tokenType": {},
        "tokenValue": "texto"
      },
      "warrantyCode": "texto",
      "expirationDate": "2025-08-11T13:45:00Z"
    }
  ],
  "observations": "texto"
};

const resp = await fetch(`${baseUrl}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/doneWarrantyRevision`, {
  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