7 - Consultar Escriturações

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

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

const options = {method: 'GET'};

fetch('https://api.example.com/contrato/consultar-escrituracoes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/contrato/consultar-escrituracoes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/contrato/consultar-escrituracoes"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/contrato/consultar-escrituracoes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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>"
      }
    }
  ]
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "Erro": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "Erro": "<string>"
}

{
  "Erro": "<string>"
}

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

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

const options = {method: 'GET'};

fetch('https://api.example.com/contrato/consultar-escrituracoes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/contrato/consultar-escrituracoes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/contrato/consultar-escrituracoes"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/contrato/consultar-escrituracoes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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>"
      }
    }
  ]
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "Erro": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "Erro": "<string>"
}

{
  "Erro": "<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

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

Guia Inicial

Métodos de Assinatura

Guia do Desenvolvedor

Referências de API

Guias e Casos de Uso

7 - Consultar Escriturações

Parâmetros de consulta

Resposta