POST/v{version}/CreditNote/{id}/paymentRevisionLiquidationSchedule

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

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
`liquidationScheduleItems`	`array de objeto`	obrigatório	Itens do 'Roteiro de Liquidação' que serão alterados/adiconados	objeto — ver detalhe abaixo	`[ … ]`

Detalhe de `liquidationScheduleItems`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`liquidationScheduleId`	`string (uuid)`	opcional	Id do LiquidationSchedule, preencher em caso de edição	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`liquidationSchedule`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`

Detalhe de `liquidationSchedule`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`amountInCents`	`integer (int64)`	obrigatório	—	—	`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"`

Detalhe de `pixQrCode`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`qrCode`	`string`	obrigatório	—	—	`"texto"`

Detalhe de `bankSlip`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`barcodeOrDigitableLine`	`string`	obrigatório	—	—	`"texto"`

Detalhe de `pixKey`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`key`	`string`	obrigatório	—	—	`"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`	obrigatório	—	objeto — ver detalhe abaixo	`{ … }`
`type`	`string`	obrigatório	—	`Transfer`, `Pix`	`"Transfer"`

Detalhe de `to`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`name`	`string`	obrigatório	—	—	`"Fulano de Tal"`
`registrationNumber`	`string`	obrigatório	—	—	`"12345678909"`
`bankCode`	`integer`	obrigatório	—	—	`0`
`bankIspb`	`integer (int64)`	obrigatório	—	—	`0`
`agency`	`string`	obrigatório	—	—	`"texto"`
`accountNumber`	`string`	obrigatório	—	—	`"texto"`
`accountType`	`string`	obrigatório	—	`NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount`	`"NaturalCheckingAccount"`

Exemplo de corpo

{
  "liquidationScheduleItems": [
    {
      "liquidationScheduleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "liquidationSchedule": {
        "amountInCents": 0,
        "pixQrCode": {},
        "bankSlip": {},
        "pixKey": {},
        "transfer": {},
        "description": "texto",
        "informedDueDate": "2025-08-11T13:45:00Z"
      }
    }
  ]
}

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/paymentRevisionLiquidationSchedule" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "liquidationScheduleItems": [
    {
      "liquidationScheduleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "liquidationSchedule": {
        "amountInCents": 0,
        "pixQrCode": {},
        "bankSlip": {},
        "pixKey": {},
        "transfer": {},
        "description": "texto",
        "informedDueDate": "2025-08-11T13:45:00Z"
      }
    }
  ]
}'

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

var corpo = new StringContent(
    """
    {
      "liquidationScheduleItems": [
        {
          "liquidationScheduleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "liquidationSchedule": {
            "amountInCents": 0,
            "pixQrCode": {},
            "bankSlip": {},
            "pixKey": {},
            "transfer": {},
            "description": "texto",
            "informedDueDate": "2025-08-11T13:45:00Z"
          }
        }
      ]
    }
    """,
    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 = {
  "liquidationScheduleItems": [
    {
      "liquidationScheduleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "liquidationSchedule": {
        "amountInCents": 0,
        "pixQrCode": {},
        "bankSlip": {},
        "pixKey": {},
        "transfer": {},
        "description": "texto",
        "informedDueDate": "2025-08-11T13:45:00Z"
      }
    }
  ]
};

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