TOTVS - RESTFul API


Service: /reportesocialbaseconfer/

Serviço dos Relatórios de Conferência do eSocial

Métodos

GET
api/rh/esocial/v1/reportEsocialBaseConfer/FgtsValues/?{companyId}&{requestId}&{synthetic}&{differencesOnly}&{page}&{pageSize}

Description

Método para consultar resultado do relatório de conferência de FGTS

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
companyid string required
requestid string required
synthetic boolean optional
differencesonly boolean optional
page integer optional
pagesize integer optional

GET
api/rh/esocial/v1/reportEsocialBaseConfer/InssRetValues/?{companyId}&{requestId}&{differencesOnly}&{synthetic}&{page}&{pageSize}

Description

Método para consultar os valores sintéticos do Relatório de conferência de INSS

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
companyid string required
requestid string required
differencesonly boolean optional
synthetic boolean optional
page integer optional
pagesize integer optional

GET
api/rh/esocial/v1/reportEsocialBaseConfer/InssValues/?{companyId}&{requestId}&{synthetic}&{differencesOnly}&{cpfNumber}&{page}&{pageSize}

Description

Método para consultar resultado do relatório de conferência de INSS

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
companyid string required
requestid string required
synthetic boolean optional
differencesonly boolean optional
cpfnumber string optional
page integer optional
pagesize integer optional

GET
api/rh/esocial/v1/reportEsocialBaseConfer/IrrfRetValues/?{companyId}&{requestId}&{differencesOnly}&{warningsOnly}&{synthetic}&{page}&{pageSize}

Description

Método para consultar os valores sintéticos do Relatório de conferência de Irrf

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
companyid string required
requestid string required
level string optional
cpfnumber string optional
differencesonly boolean optional
warningsonly boolean optional
page integer optional
pagesize integer optional
demonstrativeid string optional

GET
api/rh/esocial/v1/reportEsocialBaseConfer/LegacyStatus/?{companyId}

Description

Método para consultar o Status da API de valores das linhas

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
companyid string required

GET
api/rh/esocial/v1/reportEsocialBaseConfer/Status/?{companyId}&{requestId}

Description

Método para consultar o percentual de execução do relatório

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
companyid string required
requestid string required

POST
api/rh/esocial/v1/reportEsocialBaseConfer/?{companyId}&{registrationNumber}&{lotationCode}&{eSocialCategory}&{cpfNumber}&{eSocialRegistration}&{paymentPeriod}&{tribute}

Description

Método para iniciar o processamento do relatório de conferência do eSocial

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined