Consultar Evento
A rota Consulta Evento é utilizada sempre que for necessário consultar um determinado evento dentro de um lote enviado.
Rota da API
GET https://api.tecnospeed.com.br/esocial/v1/evento/consultar/<IDdoLote>/<IDdoEvento>
Parâmetros
Route params
Nome | Descrição | Exemplo | Valores |
---|---|---|---|
IDdoLote | Identificador do lote | fca57a93-4b35-4f9c-a44f-316d8b81de02 | ID do lote que deseja consultar |
IDdoEvento | Identificador do evento | ID1081871680000002018082317374600001 | ID do evento que deseja consultar |
Query params
Nome | Descrição | Exemplo | Valores |
ambiente | Ambiente de envio do Evento | 2 | 1 - Produção ou 2 - Homologação |
Headers
Nome | Descrição | Exemplo | Valores |
cnpj_sh | CNPJ da Software House | 08187168000160 | CNPJ do contrato com a Tecnospeed |
token_sh | Token da Software House | gerar o token em https://conta.tecnospeed.com.br/ | O acesso é diferente do portal do cliente, então mesmo que já acesse o portal do cliente é necessário criar um novo acesso |
empregador | CNPJ ou CPF do empregador | 08187168000160 | CNPJ do empregador que esta fazendo o envio |
Exemplo
GET https://api.tecnospeed.com.br/esocial/v1/evento/consultar/fca57a93-4b35-4f9c-a44f-316d8b81de02/ID1081871680000002018082317374600001
Retorno
O retorno será um JSON com a seguinte estrutura:
Nome | Descrição | Exemplo |
message | Mensagem de retorno da API | Evento sendo enviado para SEFAZ |
id | Protocolo de controle | fca57a93-4b35-4f9c-a44f-316d8b81de02 |
codigo | Codigo de retorno da API | 50 |
mensagem | Mensagem de retorno da API | Lote Recebido com Sucesso |
ambiente | Identificador do ambiente de envio | 2 |
Exemplo de retorno:
{
"message": "Evento retornado",
"data": {
"xml_evento": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<root>\n <_id>4069090d-1d16-432d-b83e-160casda803314a6af</_id>\n <eventos>\n <xmlns>http://www.esocial.gov.br/schema/evt/evtTabHorTur/v02_04_02</xmlns>\n <evtTabHorTur>\n <Id>ID10811546800005452018072610501700021</Id>\n <ideEvento>\n <tpAmb>2</tpAmb>\n <procEmi>1</procEmi>\n <verProc>1.0</verProc>\n </ideEvento>\n <ideEmpregador>\n <tpInsc>1</tpInsc>\n <nrInsc>085481238</nrInsc>\n </ideEmpregador>\n <infoHorContratual>\n <inclusao>\n <ideHorContratual>\n <codHorContrat>2507121</codHorContrat>\n <iniValid>2018-05</iniValid>\n </ideHorContratual>\n <dadosHorContratual>\n <hrEntr>0800</hrEntr>\n <hrSaida>1700</hrSaida>\n <durJornada>480</durJornada>\n <perHorFlexivel>S</perHorFlexivel>\n <horarioIntervalo>\n <tpInterv>1</tpInterv>\n <durInterv>15</durInterv>\n <iniInterv>1700</iniInterv>\n <termInterv>1715</termInterv>\n </horarioIntervalo>\n </dadosHorContratual>\n </inclusao>\n </infoHorContratual>\n </evtTabHorTur>\n <id>ID10818716800000020112312250145700021</id>\n <status>\n <codigo>201</codigo>\n <mensagem>Sucesso.</mensagem>\n </status>\n <recibo>1.2.294820499111199</recibo>\n </eventos>\n</root>",
"status": {
"codigo": "201",
"mensagem": "Sucesso;"
},
recibo: "1.2.1231231231232",
: "ID108184748980000002018072610501700021",
json_evento": " {
"xmlns": "http://www.esocial.gov.br/schema/evt/evtTabHorTur/v02_04_02",
"evtTabHorTur": {
"Id": "ID108184748980000002018072610501700021",
"ideEvento": {
"tpAmb": "2",
"procEmi": "1",
"verProc": "1.0"
},
"ideEmpregador": {
"tpInsc": "1",
"nrInsc": "123213123"
},
"infoHorContratual": {
"inclusao": {
"ideHorContratual": {
"codHorContrat": "123123",
"iniValid": "2018-05"
},
"dadosHorContratual": {
"hrEntr": "0800",
"hrSaida": "1700",
"durJornada": "480",
"perHorFlexivel": "S",
"horarioIntervalo": {
"tpInterv": "1",
"durInterv": "15",
"iniInterv": "1700",
"termInterv": "1715"
}
}
}
}
",
"xmlns": "http://www.esocial.gov.br/schema/evt/evtTabHorTur/v02_04_02",
"evtTabHorTur": {
"Id": "ID108184748980000002018072610501700021",
"ideEvento": {
"tpAmb": "2",
"procEmi": "1",
"verProc": "1.0"
},
"ideEmpregador": {
"tpInsc": "1",
"nrInsc": "123213123"
},
"infoHorContratual": {
"inclusao": {
"ideHorContratual": {
"codHorContrat": "123123",
"iniValid": "2018-05"
},
"dadosHorContratual": {
"hrEntr": "0800",
"hrSaida": "1700",
"durJornada": "480",
"perHorFlexivel": "S",
"horarioIntervalo": {
"tpInterv": "1",
"durInterv": "15",
"iniInterv": "1700",
"termInterv": "1715"
}
}
}
}
",
}
}
Exemplo de retorno com erro:
{
"error": {
"message": "Evento não encontrado".
}
}
Comentários
0 comentário
Por favor, entre para comentar.