Criar escrituração de desconto no eSocial

POST/v1/massa-dados/escrituracao

🔒 Requer Bearer token

Escopo emprestimos:write. **Disponível apenas em staging e homologação.** Popula a base de HOMOLOGAÇÃO da Dataprev com dados fictícios; em produção esta rota não existe (404). Inclui um evento de remuneração do eSocial referente ao desconto de uma parcela — é o que faz o contrato aparecer em GET /v1/escrituracao. Omita numero_contrato_emprestimo quando o desconto se referir ao próprio contrato escriturado.

Corpo da requisição

numero_contrato_escrituracaostringobrigatório

Número do contrato escriturado no eSocial.

máx. 60 car.

id_eventostringobrigatório

Identificador do evento de remuneração no eSocial.

máx. 60 car.

periodo_referenciastringobrigatório

Período de referência do evento (`yyyyMM`).

padrão: ^\d{6}$

valor_parcela_descontonumberobrigatório

Valor da parcela descontada em folha.

≥ 0

cpf_trabalhadorstringobrigatório

CPF do trabalhador (11 dígitos).

padrão: ^\d{11}$

matriculastringopcional

Matrícula do trabalhador no empregador.

máx. 30 car.

codigo_inscricao_empregadornumberobrigatório

Código do tipo de inscrição do empregador (1=CNPJ, 2=CPF).

numero_inscricao_empregadorstringobrigatório

Número de inscrição do empregador. É **string**: o CNPJ pode ser alfanumérico (IN RFB 2.229/2024, ex.: `R7ZW4H8H000140`) e zeros à esquerda são significativos. Máscara (`.`, `/`, `-`) é aceita e removida.

máx. 30 car. · padrão: ^[A-Z0-9]{1,30}$

valor_parcela_emprestimonumberopcional

Valor da parcela do empréstimo (para conferência com o desconto).

codigo_if_emprestimonumberopcional

Código da instituição financeira do empréstimo.

numero_contrato_emprestimostringopcional

Número do contrato do empréstimo, quando diferente do contrato escriturado.

máx. 60 car.

Respostas

Corpo da resposta 201

numero_contrato_escrituracaostringobrigatório

codigo_if_escrituracaointegerobrigatório

id_eventostringobrigatório

periodo_referenciastringobrigatório

valor_parcela_descontonumberobrigatório

valor_parcela_emprestimonumberobrigatório

codigo_if_emprestimointegerobrigatório

numero_contrato_emprestimostringobrigatório

cpf_trabalhadorstringobrigatório

matriculastringobrigatório

codigo_inscricao_empregadorintegerobrigatório

numero_inscricao_empregadorstringobrigatório

Request

curl -X POST 'https://econsignado-api.socinal.com.br/v1/massa-dados/escrituracao' \
  -H 'Authorization: Bearer SEU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "numero_contrato_escrituracao": "199912345678",
  "id_evento": "ID.999999.202504.0001",
  "periodo_referencia": "202504",
  "valor_parcela_desconto": 200,
  "cpf_trabalhador": "87070728050",
  "matricula": "MAT-99999999999999213",
  "codigo_inscricao_empregador": 1,
  "numero_inscricao_empregador": "11111111111111",
  "valor_parcela_emprestimo": 200,
  "codigo_if_emprestimo": 997,
  "numero_contrato_emprestimo": "199912345678"
}'

Response

{
  "numero_contrato_escrituracao": "199912345678",
  "codigo_if_escrituracao": 997,
  "id_evento": "ID.999999.202504.0001",
  "periodo_referencia": "202504",
  "valor_parcela_desconto": 200,
  "valor_parcela_emprestimo": 200,
  "codigo_if_emprestimo": 997,
  "numero_contrato_emprestimo": "199912345678",
  "cpf_trabalhador": "87070728050",
  "matricula": "MAT-99999999999999213",
  "codigo_inscricao_empregador": 1,
  "numero_inscricao_empregador": "11111111111111"
}