Pular para o conteúdo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Fechar lote de Recebimento/Atribuição

Realiza o fechamento de um lote de eventos de recebimento/atribuição, com a verificação dos valores totais presente no lote.

Esta chamada deve ser executada somente após o envio de todas as importações de recebimentos/atribuições do lote.

Fechar lote de recebimentos/atribuições

post
/integration/contract/batch-events/close
Autorizações
AuthorizationstringObrigatório
Corpo
emissor_cnpjstring · máx: 18Obrigatório

CNPJ do emissor (Securitizadora/Fundo) para fechamento do lote de eventos de contrato.

  • Formato: Pode ser enviado com ou sem pontuação.
  • CNPJ numérico: 14 dígitos (ex.: 55.759.179/0001-57).
  • CNPJ alfanumérico: 12 caracteres alfanuméricos (A-Z, 0-9) + 2 dígitos verificadores numéricos (ex.: VK80.3CNK/0001-59).
  • Normalização: A API remove pontuação, mantém apenas letras e números e converte letras para maiúsculas.
  • Validação: Dígitos verificadores Mod11 (incluindo CNPJ alfanumérico).
  • Erros: Documento CNPJ '{valor}' invalido.; A identificacao do emissor '{valor}' e invalida para o emissor autenticado.
Example: 06.983.813/0001-25Pattern: ^(\d{2}\.\d{3}\.\d{3}/\d{4}-\d{2}|[A-Za-z0-9]{2}\.[A-Za-z0-9]{3}\.[A-Za-z0-9]{3}/[A-Za-z0-9]{4}-\d{2}|\d{14}|[A-Za-z0-9]{12}\d{2})$
numero_lote_eventostring · máx: 12Obrigatório

Número do lote de eventos do contrato.

quantidade_totalintegerObrigatório

Quantidade total dos eventos no lote.

valor_totalnumber · decimalObrigatório

Valor total de eventos de RECEBIMENTO no lote.

Respostas
200

Lote fechado com sucesso

application/json
emissor_cnpjstring · máx: 18Obrigatório

CNPJ do emissor (Securitizadora/Fundo) do evento de contrato.

  • Formato: Pode ser enviado com ou sem pontuação.
  • CNPJ numérico: 14 dígitos (ex.: 55.759.179/0001-57).
  • CNPJ alfanumérico: 12 caracteres alfanuméricos (A-Z, 0-9) + 2 dígitos verificadores numéricos (ex.: VK80.3CNK/0001-59).
  • Normalização: A API remove pontuação, mantém apenas letras e números e converte letras para maiúsculas.
  • Validação: Dígitos verificadores Mod11 (incluindo CNPJ alfanumérico).
  • Erros: Documento CNPJ '{valor}' invalido.; A identificacao do emissor '{valor}' e invalida para o emissor autenticado.
Example: VK80.3CNK/0001-59Pattern: ^(\d{2}\.\d{3}\.\d{3}/\d{4}-\d{2}|[A-Za-z0-9]{2}\.[A-Za-z0-9]{3}\.[A-Za-z0-9]{3}/[A-Za-z0-9]{4}-\d{2}|\d{14}|[A-Za-z0-9]{12}\d{2})$
numero_lote_eventostring · máx: 12Obrigatório

Identificador do lote de eventos do contrato.

  • Formato: Numérico (aceita somente números).
  • Regra: Deve ser único. Sem vínculo com um lote já fechado. Não deve conter zeros à esquerda.
numero_contratostring · máx: 50Obrigatório

Número do contrato.

  • Formato: Texto (aceita letras, números e caracteres especiais).
  • Regra: Deve ser único.
tipo_eventostring · enumObrigatório

Tipo do evento associado ao contrato.

Valores possíveis:
valor_eventonumber · decimal · máx: 14Opcional

Valor do evento.

  • Opcionalidade: Obrigatório para os tipos de evento: RECEBIMENTO e ATRIBUIR_VALOR_INFORMADO.
  • Formato: Numérico no padrão 10,4 (10 dígitos inteiros, 4 decimais).
  • Sinal: Deve ser positivo.
modo_atribuicaostring · enum · máx: 50Opcional

Modo de atribuição do evento.

  • Opcionalidade: Obrigatório para os tipos de evento: ATRIBUIR_VALOR_DISPONIVEL e ATRIBUIR_VALOR_INFORMADO.
Valores possíveis:
numero_controle_participantestring · máx: 80Opcional

Número de controle do participante do recebível.

  • Utilização: Necessário para o modo de atribuição LIQUIDACAO_RECEBIVEL.
  • Padrão: Deve seguir o padrão número-parcela (ex: 12345678-1).
  • Formato: Texto (aceita letras, números e caracteres especiais).
post/integration/contract/batch-events/close
POST /integration/contract/batch-events/close HTTP/1.1
Host: integration.staging.gtsec.giro.tech
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "emissor_cnpj": "06.983.813/0001-25",
  "numero_lote_evento": "5061",
  "quantidade_total": 3,
  "valor_total": 5000
}
{
  "emissor_cnpj": "VK80.3CNK/0001-59",
  "numero_lote_evento": "text",
  "numero_contrato": "text",
  "tipo_evento": "RECEBIMENTO",
  "valor_evento": 1,
  "modo_atribuicao": "LIQUIDACAO_CONTRATO",
  "numero_controle_participante": "text"
}

Atualizado