PUT/v{version}/CreditNote/{id}/upload

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

Atualiza a lista de documentos atrelados à operação

Atualiza por completo um registro de Credit Note existente.

Visão geral

Atualiza a lista de documentos atrelados à operação. Permitido apenas quando o status da operação é Rascunho, Revisão, Aprovação de Instrumento ou Coleta de Assinaturas.

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
`uploads`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`

Detalhe de `uploads`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`ownerUser`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`ownerGroup`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`id`	`string (uuid)`	opcional	Id do arquivo	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`fileName`	`string`	obrigatório	Nome do arquivo (retornado pelo GET v1/Upload)	—	`"Fulano de Tal"`
`fileType`	`string`	opcional	—	`Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others` +41	`"Document"`
`displayName`	`string`	opcional	Nome de exibição do arquivo	—	`"Fulano de Tal"`
`documentDate`	`string (date-time)`	opcional	Data do próprio documento (emissão/referência), não a data do upload. Aceita em qualquer tipo de documento e sempre opcional. Só tem efeito de negócio no laudo de deferimento INSS e na última perícia INSS (regra de elegibilidade dos benefícios 32/92).	—	`"2025-08-11T13:45:00Z"`

Detalhe de `ownerUser`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`userId`	`string`	obrigatório	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`tenantName`	`string`	obrigatório	—	—	`"Fulano de Tal"`

Detalhe de `ownerGroup`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`groupId`	`string`	obrigatório	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`tenantName`	`string`	obrigatório	—	—	`"Fulano de Tal"`

Exemplo de corpo

{
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal",
      "documentDate": "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 PUT "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/upload" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal",
      "documentDate": "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/upload";

var corpo = new StringContent(
    """
    {
      "uploads": [
        {
          "ownerUser": {
            "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "tenantName": "Fulano de Tal"
          },
          "ownerGroup": {
            "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "tenantName": "Fulano de Tal"
          },
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "fileName": "Fulano de Tal",
          "fileType": "Document",
          "displayName": "Fulano de Tal",
          "documentDate": "2025-08-11T13:45:00Z"
        }
      ]
    }
    """,
    Encoding.UTF8, "application/json");

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

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

const payload = {
  "uploads": [
    {
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal"
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z"
    }
  ]
};

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