7 - Consultar Escriturações

Retorna os registros de escrituração dos contratos consignados dentro de um intervalo de data/hora especificado, com paginação.

Consulta escriturações (registros) de contratos em um período.

cURL

curl --request GET \
  --url https://api.example.com/contrato/consultar-escrituracoes

200

{
  "NroPaginaAtual": 123,
  "NroTotalPaginas": 123,
  "NroTotalRegistros": 123,
  "QtdRegistrosPorPagina": 123,
  "QtdRegistrosPaginaAtual": 123,
  "Conteudo": [
    {
      "Id": 123,
      "IdEvento": "<string>",
      "PeriodoReferencia": 123,
      "CodigoIF": 123,
      "Contrato": "<string>",
      "ValorParcelaDesconto": 123,
      "Cpf": 123,
      "InscricaoEmpregador": {
        "Codigo": 123,
        "Descricao": "<string>"
      },
      "NumeroInscricaoEmpregador": 123,
      "Matricula": "<string>",
      "DataHoraInclusaoDataprev": "2023-11-07T05:31:56Z",
      "IdEventoExclusao": "<string>",
      "DataHoraEventoExclusao": "<string>",
      "IdEventoRetificacao": "<string>",
      "DataHoraEventoRetificacao": "<string>",
      "Emprestimo": {
        "CodigoIf": 123,
        "Contrato": "<string>",
        "ValorParcela": 123
      },
      "Analise": {
        "ExisteTrabalhadorEscriturado": true,
        "ExisteNumeroContratoEscriturado": true,
        "VinculoCorreto": true,
        "InstituicaoFinanceiraCorreta": true,
        "ValorParcelaCorreta": true,
        "DadosCorrespondentes": true
      },
      "TipoEventoESocial": {
        "Codigo": 123,
        "Descricao": "<string>"
      }
    }
  ]
}

Parâmetros de consulta

DataHoraInicio · string · obrigatório

Data/hora de início da consulta (formato ddMMyyyyHHmmss).

DataHoraFim · string · obrigatório

Data/hora de fim da consulta (formato ddMMyyyyHHmmss).

NroPagina · string

Número da página (para paginação, opcional).

Resposta

200

application/json

OK

NroPaginaAtual · integer<int32> · obrigatório

Número da página atual.

NroTotalPaginas · integer<int32> · obrigatório

Número total de páginas.

NroTotalRegistros · integer<int32> · obrigatório

Total de registros encontrados.

QtdRegistrosPorPagina · integer<int32> · obrigatório

Quantidade de registros por página.

QtdRegistrosPaginaAtual · integer<int32> · obrigatório

Quantidade de registros nesta página.

Conteudo · object[] · obrigatório

Lista de escriturações retornadas.

Show child attributes