Este detalhamento tem como objetivo registrar os endpoints da interface da integração da tela desenvolvida utilizando PO-UI. | Deck of Cards |
|---|
| | Card |
|---|
| id | params |
|---|
| label | creditoTrabalhadorParams |
|---|
| creditoTrabalhadorParams : Obter a configuração necessária para a integração com o webservice do TSS. Tipo de requisição: GET Endpoint: /api/rh/v1/creditoTrabalhadorParams Estrutura de Retorno: Campo | Tipo | Descrição | Exemplo | Obrigatório? | isMiddleware | boolean | Utiliza Middleware? | true | Sim | urlTSS | string | URL do TSS (apenas quando for Middleware) | "http://localhost:8480/" | Para TAF, retornar vazio. | environment | string | Identificação do Ambiente (e-Social) ex: 1-Produção, 3-Produção restrita | "3" | Para TAF, retornar vazio. |
Exemplo de Requisição: GET: /api/rh/v1/creditoTrabalhadorParams | Expandir |
|---|
| {
"isMiddleware" : false,
"urlTSS" : "",
"environment" : ""
} |
| Card |
|---|
| id | employers |
|---|
| label | creditoTrabalhadorEmployers |
|---|
| creditoTrabalhadorEmployers: Obter os empregadores que serão consultados no governo. Tipo de requisição: GET Endpoint: /api/rh/v1/creditoTrabalhadorEmployers
Estrutura de Retorno: Campo | Campo pai | Tipo | Descrição | Exemplo | Obrigatório? | items | - | array | Lista de empregadores | [ ] | Sim | employerCode | items | string | Código da Filial (Entidade quando é Middleware) | "000021" | Sim | employerName | items | string | Nome, descrição do empregador | "M PR 02 - Filial CASCAVEL" | Sim |
- Para TAF: Retornar as filiais matrizes;
- Para MID: Retornar o código das entidades no TSS;
Exemplo de Requisição: GET: /api/rh/v1/creditoTrabalhadorEmployers {
"items": [
{
"employerCode": "000019",
"employerName": "D MG 01 - Filial BELO HOR"
},
{
"employerCode": "000020",
"employerName": "D RJ 02 - Filial NITEROI"
},
{
"employerCode": "000021",
"employerName": "M PR 02 - Filial CASCAVEL"
}
]
} |
| Card |
|---|
| id | getCredTrab |
|---|
| label | (GET) creditoTrabalhadorTSS |
|---|
| credito-trabalhador: Retorna o json com os empréstimos carregados do TAF. Tipo de requisição: GET Endpoint: /api/rh/v1/creditoTrabalhadorTSS
Estrutura de parâmetros que podem ser passados na requisição (GET): Atributo | Descrição | Formato |
|---|
sourceBranch | Código da empresa. | string | period | Competência dos dados consultados (Ex.: 202501) | string | forceRequest | Força uma nova consulta no governo? | boolean |
Exemplo da URL na requisição: http://localhost:8104/api/rh/v1/creditoTrabalhadorTSS?sourceBranch=000021&period=202509&forceRequest=true
Retorno deve ser o mesmo documentado pelo TAF em Web Service REST - Consulta Crédito do Trabalhador:
| Expandir |
|---|
| { "Ambiente": "2", "Arquivo": "W3siaWZDb25jZXNzb3JhLmNvZGlnbyI6MTA0LCJpZkNvbmNlc3NvcmEuZGVzY3JpY2FvIjoiQmFuY28gWFlaIiwiY29udHJhdG8iOiJDT05UUkFUTzEyMzQ1NiIsImNwZiI6IjY5Njk1NDk4MDE5IiwibWF0cmljdWxhIjoiTUFUMTIzNDU2IiwiaW5zY3JpY2FvRW1wcmVnYWRvci5jb2RpZ28iOjEsImluc2NyaWNhb0VtcHJlZ2Fkb3IuZGVzY3JpY2FvIjoiQ05QSiIsIm51bWVyb0luc2NyaWNhb0VtcHJlZ2Fkb3IiOiI1MzExMzc5MSIsImluc2NyaWNhb0VzdGFiZWxlY2ltZW50by5jb2RpZ28iOjEsImluc2NyaWNhb0VzdGFiZWxlY2ltZW50by5kZXNjcmljYW8iOiJDTlBKIiwibnVtZXJvSW5zY3JpY2FvRXN0YWJlbGVjaW1lbnRvIjoiNTMxMTM3OTEwMDAxMjIiLCJub21lVHJhYmFsaGFkb3IiOiJUcmFiYWxoYWRvciBUZXN0ZSIsIm5vbWVFbXByZWdhZG9yIjoiRW1wcmVnYWRvciBUZXN0ZSIsImRhdGFJbmljaW9Db250cmF0byI6IjEwLzEyLzIwMjQiLCJkYXRhRmltQ29udHJhdG8iOiIxMC8xMi8yMDI1IiwiY29tcGV0ZW5jaWFJbmljaW9EZXNjb250byI6IjAxLzIwMjUiLCJjb21wZXRlbmNpYUZpbURlc2NvbnRvIjoiMTIvMjAyNSIsInRvdGFsUGFyY2VsYXMiOjEyLCJ2YWxvclBhcmNlbGEiOjM1MCwidmFsb3JFbXByZXN0aW1vIjozNTAwLCJ2YWxvckxpYmVyYWRvIjowLCJjYXRlZ29yaWFUcmFiYWxoYWRvci5jb2RpZ28iOjEwNCwiY2F0ZWdvcmlhVHJhYmFsaGFkb3IuZGVzY3JpY2FvIjoiRW1wcmVnYWRvIC0gRG9tw6lzdGljbyIsInF0ZFBhZ2FtZW50b3MiOjEsInF0ZEVzY3JpdHVyYWNvZXMiOjEsImNvbXBldGVuY2lhIjoiMDEvMjAyNSIsImRhdGFBZG1pc3NhbyI6IjExLzA5LzIwMDUifSx7ImlmQ29uY2Vzc29yYS5jb2RpZ28iOjIzNywiaWZDb25jZXNzb3JhLmRlc2NyaWNhbyI6IkJhbmNvIFhZWiIsImNvbnRyYXRvIjoiQ09OVFJBVE8xMjM0NTYiLCJjcGYiOiI2MDg1MDUyNjAwMCIsIm1hdHJpY3VsYSI6Ik1BVDEyMzQ1NiIsImluc2NyaWNhb0VtcHJlZ2Fkb3IuY29kaWdvIjoxLCJpbnNjcmljYW9FbXByZWdhZG9yLmRlc2NyaWNhbyI6IkNOUEoiLCJudW1lcm9JbnNjcmljYW9FbXByZWdhZG9yIjoiNTMxMTM3OTEiLCJpbnNjcmljYW9Fc3RhYmVsZWNpbWVudG8uY29kaWdvIjoxLCJpbnNjcmljYW9Fc3RhYmVsZWNpbWVudG8uZGVzY3JpY2FvIjoiQ05QSiIsIm51bWVyb0luc2NyaWNhb0VzdGFiZWxlY2ltZW50byI6IjUzMTEzNzkxMDAwMTIyIiwibm9tZVRyYWJhbGhhZG9yIjoiVHJhYmFsaGFkb3IgVGVzdGUiLCJub21lRW1wcmVnYWRvciI6IkVtcHJlZ2Fkb3IgVGVzdGUiLCJkYXRhSW5pY2lvQ29udHJhdG8iOiIxMC8xMi8yMDI0IiwiZGF0YUZpbUNvbnRyYXRvIjoiMTAvMTIvMjAyNSIsImNvbXBldGVuY2lhSW5pY2lvRGVzY29udG8iOiIwMS8yMDI1IiwiY29tcGV0ZW5jaWFGaW1EZXNjb250byI6IjEyLzIwMjUiLCJ0b3RhbFBhcmNlbGFzIjoxMiwidmFsb3JQYXJjZWxhIjozNTAsInZhbG9yRW1wcmVzdGltbyI6MzUwMCwidmFsb3JMaWJlcmFkbyI6MCwiY2F0ZWdvcmlhVHJhYmFsaGFkb3IuY29kaWdvIjoxMDQsImNhdGVnb3JpYVRyYWJhbGhhZG9yLmRlc2NyaWNhbyI6IkVtcHJlZ2FkbyAtIERvbcOpc3RpY28iLCJxdGRQYWdhbWVudG9zIjoxLCJxdGRFc2NyaXR1cmFjb2VzIjoxLCJjb21wZXRlbmNpYSI6IjAxLzIwMjUiLCJkYXRhQWRtaXNzYW8iOiIxMS8wOS8yMDA1In1d", "CodRequisicao": "200", "Competencia": "202501", "DescrErro": "", "HrSolicitacao": "10:15:49", "Id": "2fb395c0-b7f5-13c2-cebe-2a2c48c9b272", "Id_ent": "000014", "Status": "1", "DtSolicitacao": "20250911" } |
|
| Card |
|---|
| id | credito-trabalhador |
|---|
| label | (POST) credito-trabalhador |
|---|
| credito-trabalhador Tipo de requisição: POST Endpoint: - /api/rh/v1/credito-trabalhador (Protheus e RM)
- /api/rh/v1/CreditoTrabalhador (Datasul)
Objetivo: Efetua a gravação os empréstimos nas tabelas do ERP e retorna o resultado.
POST: Estrutura do body: Campo | Campo pai | Tipo | Descrição | atualiza | - | boolean | Indica se deseja atualizar os empréstimos importados anteriormente. | branches | - | array | Indica as filiais que serão atualizadas no ERP. Se vazio atualiza todas. | items | - | array | Lista dos empréstimos que devem ser gravados. | ifConcessora | items | object | Instituição financeira. | codigo | ifConcessora | number | Código da Instituição financeira. | descricao | ifConcessora | string | Descrição da Instituição financeira. | contrato | items | string | Número do contrato | cpf | items | string | Número do CPF do trabalhador. | matricula | items | string | Matrícula do trabalhador no eSocial. | inscricaoEmpregador | items | object | Objeto da Inscrição do empregador | codigo | inscricaoEmpregador | number | Código correspondente ao tipo de inscrição do empregador. 1 algarismo conforme eSocial. | numeroInscricaoEmpregador | items | string | Número da inscrição do empregador. | nomeTrabalhador | items | string | Nome completo do trabalhador. | dataInicioContrato | items | string | Data de início do contrato. | dataFimContrato | items | string | Data de término do contrato. | competenciaInicioDesconto | items | string | Competência inicial do desconto (mês/ano). | competenciaFimDesconto | items | string | Competência final do desconto (mês/ano). | totalParcelas | items | number | Total de parcelas do empréstimo. | valorParcela | items | number | Valor de cada parcela. | valorEmprestimo | items | number | Valor total do empréstimo. | valorLiberado | items | number | Valor que foi liberado. | qtdPagamentos | items | number | Quantidade de pagamentos realizados. | qtdEscrituracoes | items | number | Quantidade de escriturações. | categoriaTrabalhador | items | object | Objeto com informações da categoria do trabalhador. | codigo | categoriaTrabalhador | number | Código da categoria do trabalhador. | competencia | items | string | Competência (mês/ano). | inscricaoEstabelecimento | items | object | Objeto com informações da inscrição do estabelecimento. | codigo | inscricaoEstabelecimento | number | Código correspondente ao tipo de inscrição do estabelecimento. 1 algarismo conforme eSocial. | numeroInscricaoEstabelecimento | items | string | Número da inscrição do estabelecimento. | dataAdmissao | items | string | Data de admissão do trabalhador. | _index | items | number | Índice do item na lista. (gerado no momento da importação) |
| Expandir |
|---|
| title | Exemplo body, payload |
|---|
| {
"atualiza": true,
"branches": [
"estabelecimento 01",
"estabelecimento 02"
],
"items": [
{
"ifConcessora": {
"codigo": 0,
"descricao": "string"
},
"contrato": "string",
"cpf": "string",
"matricula": "string",
"inscricaoEmpregador": {
"codigo": 1
},
"numeroInscricaoEmpregador": "string",
"nomeTrabalhador": "string",
"dataInicioContrato": "01/05/2025",
"dataFimContrato": "string",
"competenciaInicioDesconto": "05/2025",
"competenciaFimDesconto": "08/2025",
"totalParcelas": 1,
"valorParcela": 100.99,
"valorEmprestimo": 400.99,
"valorLiberado": 300.99,
"qtdPagamentos": 0,
"qtdEscrituracoes": 0,
"categoriaTrabalhador": {
"codigo": 101
},
"competencia": "05/2025",
"inscricaoEstabelecimento": {
"codigo": 1
},
"numeroInscricaoEstabelecimento": "string",
"dataAdmissao": "28/02/2020",
"_index": 0
}
]
} |
Estrutura do Retorno: Campo | Campo pai | Tipo | Exemplo | items | - | array | Lista com o retorno do processamento de cada emprestimo | _index | items | number | Índice do item na lista. (deve retornar o índice recebido no body) | _emp | items | string | Empresa do trabalhador. | _fil | items | string | Filial/Estabelecimento onde o trabalhador foi encontrado. | _fun | items | string | Código do Trabalhador no ERP. | _status | items | string | Status do processamento, onde: 0=Não Processado; 1=Sucesso; 2=Alerta informativo e 3=Rejeitado | _obs | items | String | Mensagem detalhada em caso de empréstimo Rejeitado ou Alerta informativo. |
| Expandir |
|---|
| {
"items": [
{
"_index": 0,
"_emp": "",
"_fil": "",
"_fun": "",
"_status": "1",
"_obs": "string"
}
]
} |
Para o retorno de erro, seguir a estrutura abaixo. Campo | Tipo | code | number | message | string | detailedMessage | string | type | string (“error”, “warning”, “success”) |
| Expandir |
|---|
| {
"code": 500,
"detailedMessage": "",
"message": "Internal Server Error",
"type": "error"
} |
|
|
|
