Portal Criar conta

Envio de eventos · Enviar um evento

Enviar um evento

Envia um evento do eSocial em JSON. Conferimos na hora contra o schema do evento; passou, ele entra na fila de transmissão e você recebe 202.

POST https://integration.enviaesocial.com.br/v1/events
Autenticação Bearer es_…
Corpo application/json
Sucesso 202 event_accepted
Reenvio seguro. O mesmo client_reference com o mesmo conteúdo volta 200 event_already_received, sem duplicar no governo.

Corpo

type texto
obrigatório

Um dos 40 tipos do catálogo, como S-2200.

employer_document texto
obrigatório

CNPJ ou CPF de um empregador cadastrado, com ou sem máscara.

layout texto
obrigatório

O leiaute aceito, hoje S-1.3. A troca de leiaute é sempre consciente.

client_reference texto
obrigatório

A sua referência, até 100 caracteres, única por empresa e ambiente.

data objeto
obrigatório

Os campos do evento escolhido em type. Os nomes podem vir em minúsculas (cpftrab) ou na grafia do leiaute do eSocial (cpfTrab); recomendamos minúsculas. Os campos de cada um dos 40 eventos, com o que é obrigatório e os exemplos, estão no Catálogo de eventos. O cabeçalho do XML (ideEmpregador, tpAmb, procEmi) é nosso: não envie.

Respostas

202 event_accepted

Aceito e na fila.

200 event_already_received

Mesmo client_reference e mesmo conteúdo: volta o evento como está agora.

422 validation_error

Erro no envelope (vem o primeiro) ou no data, que não passou no schema (vêm todos os erros de uma vez).

422 unsupported_event

type fora do catálogo.

422 unsupported_layout

layout diferente do aceito, hoje S-1.3.

422 employer_not_found

O employer_document não foi cadastrado como empregador.

422 employer_without_certificate

O certificado do empregador foi revogado ou venceu.

409 client_reference_conflict

Mesmo client_reference com outro conteúdo. Ache o original com GET /v1/events?client_reference=.

402 payment_overdue

Fatura vencida há 10 dias ou mais. Só na produção: a Produção Restrita nunca é bloqueada.

402 subscribe_required

Sem plano ativo e sem envios do bônus. Só na produção: a Produção Restrita nunca é bloqueada.

401 invalid_api_key

Chave ausente, inválida ou revogada.