POST api/eSocial/RetornoEnvio

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
protocoloEnvio	Número sequencial único produzido no instante de recepção do lote de eventos e que será utilizado como parâmetro pelo empregador no WebService de Consulta ao Resultado de Processamento do Lote.	string	None.
dhRecepcao	Contém a data/hora de recepção do lote de eventos.	date	None.
cdResposta	Contém o código de resposta do processamento do lote.	integer	None.
descResposta	Contém a descrição correspondente ao código de resposta do lote.	string	None.
Evento_XML	Arquivo Xml contendo o lote enviado ao eSocial.	Collection of byte	None.
Protocolo_XML	Arquivo Xml contendo o protocolo de envio.	Collection of byte	None.
Retorno_XML	Arquivo Xml do retorno caso ocorra algum erro no envio do lote.	Collection of byte	None.
Evento	Lista de eventos enviados no lote.	Collection of Evento	None.

Request Formats

application/json, text/json

Sample:

{
  "protocoloEnvio": "sample string 1",
  "dhRecepcao": "2025-04-25T20:23:03.6586199-03:00",
  "cdResposta": 1,
  "descResposta": "sample string 2",
  "Evento_XML": "QEA=",
  "Protocolo_XML": "QEA=",
  "Retorno_XML": "QEA=",
  "Evento": [
    {
      "Id": "sample string 1",
      "nrRecibo": "sample string 2",
      "cdResposta": 1,
      "descResposta": "sample string 3"
    },
    {
      "Id": "sample string 1",
      "nrRecibo": "sample string 2",
      "cdResposta": 1,
      "descResposta": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<LoteEnviado xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SigoW3.Models.eSocial">
  <Evento>
    <Evento>
      <Id>sample string 1</Id>
      <cdResposta>1</cdResposta>
      <descResposta>sample string 3</descResposta>
      <nrRecibo>sample string 2</nrRecibo>
    </Evento>
    <Evento>
      <Id>sample string 1</Id>
      <cdResposta>1</cdResposta>
      <descResposta>sample string 3</descResposta>
      <nrRecibo>sample string 2</nrRecibo>
    </Evento>
  </Evento>
  <Evento_XML>QEA=</Evento_XML>
  <Protocolo_XML>QEA=</Protocolo_XML>
  <Retorno_XML>QEA=</Retorno_XML>
  <cdResposta>1</cdResposta>
  <descResposta>sample string 2</descResposta>
  <dhRecepcao>2025-04-25T20:23:03.6586199-03:00</dhRecepcao>
  <protocoloEnvio>sample string 1</protocoloEnvio>
</LoteEnviado>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RetornoProcessamentoOfBoolean

Name	Type	Additional information
Sucesso	boolean	None.
Mensages	Collection of Mensagem	None.
Retorno	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Sucesso": true,
  "Mensages": [
    {
      "Descricao": "sample string 1",
      "ReferenciaCampo": "sample string 2",
      "Id": "sample string 3"
    },
    {
      "Descricao": "sample string 1",
      "ReferenciaCampo": "sample string 2",
      "Id": "sample string 3"
    }
  ],
  "Retorno": true
}

application/xml, text/xml

Sample:

<RetornoProcessamentoOfboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SigoW3.Models">
  <Mensages>
    <Mensagem>
      <Descricao>sample string 1</Descricao>
      <Id>sample string 3</Id>
      <ReferenciaCampo>sample string 2</ReferenciaCampo>
    </Mensagem>
    <Mensagem>
      <Descricao>sample string 1</Descricao>
      <Id>sample string 3</Id>
      <ReferenciaCampo>sample string 2</ReferenciaCampo>
    </Mensagem>
  </Mensages>
  <Retorno>true</Retorno>
  <Sucesso>true</Sucesso>
</RetornoProcessamentoOfboolean>