Consultar escrituração

GET/v1/escrituracao

🔒 Requer Bearer token

Escopo escrituracao:read. Lista as escriturações (descontos do eSocial) dos trabalhadores dos contratos no período informado (proxy filtrado da consulta Socinal — só retorna trabalhadores do próprio parceiro, correlacionados por CPF). Use contrato para restringir ao trabalhador de uma CCB específica. Sem registros retorna { "escrituracoes": [] }.

Parâmetros

contratostringqueryopcional

Número da CCB (contrato) do parceiro. Quando informado, a consulta é restrita a este contrato; se o contrato não pertencer ao parceiro, retorna 404.

data_iniciostringqueryopcional

Início da janela de busca (YYYY-MM-DD). Default: janela padrão do backend.

padrão: ^\d{4}-\d{2}-\d{2}$

data_fimstringqueryopcional

Fim da janela de busca (YYYY-MM-DD). Default: hoje.

padrão: ^\d{4}-\d{2}-\d{2}$

Respostas

Corpo da resposta 200

escrituracoesarray<object>obrigatório

contratostringobrigatório

cpf_trabalhadorstringobrigatório

matriculastringobrigatório

periodo_referenciastringobrigatório

inscricao_empregadorobjectobrigatório

codigointegerobrigatório

descricaostringobrigatório

numero_inscricao_empregadorstringobrigatório

valor_parcela_descontonumberobrigatório

data_inclusao_dataprevstring<date-time>obrigatório

excluidobooleanobrigatório

data_exclusaostring<date-time>obrigatórionullable

retificadobooleanobrigatório

data_retificacaostring<date-time>obrigatórionullable

tipo_evento_esocialobjectobrigatório

codigointegerobrigatório

descricaostringobrigatório

analiseobjectobrigatório

existe_trabalhador_escrituradobooleanobrigatório

existe_numero_contrato_escrituradobooleanobrigatório

vinculo_corretobooleanobrigatório

instituicao_financeira_corretabooleanobrigatório

valor_parcela_corretabooleanobrigatório

dados_correspondentesbooleanobrigatório

Request

curl -X GET 'https://econsignado-api.socinal.com.br/v1/escrituracao?contrato=valor&data_inicio=valor&data_fim=valor' \
  -H 'Authorization: Bearer SEU_TOKEN'

Response

{
  "escrituracoes": [
    {
      "contrato": "A100001-001",
      "cpf_trabalhador": "75842274574",
      "matricula": "MAT-8024716378",
      "periodo_referencia": "202505",
      "inscricao_empregador": {
        "codigo": 1,
        "descricao": "CNPJ"
      },
      "numero_inscricao_empregador": "12674953000114",
      "valor_parcela_desconto": 97.49,
      "data_inclusao_dataprev": "2026-04-30T17:35:44.000Z",
      "excluido": false,
      "data_exclusao": null,
      "retificado": false,
      "data_retificacao": null,
      "tipo_evento_esocial": {
        "codigo": 1,
        "descricao": "Inclusão"
      },
      "analise": {
        "existe_trabalhador_escriturado": true,
        "existe_numero_contrato_escriturado": true,
        "vinculo_correto": true,
        "instituicao_financeira_correta": true,
        "valor_parcela_correta": true,
        "dados_correspondentes": true
      }
    }
  ]
}