TOTVS - RESTFul API


Service: /payrollloan/

Serviço para consulta de dados do TOTVS Consignado.

Métodos

GET
rh/payrollLoan/v1/person/address

Description

Consulta o endereço da pessoa

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

GET
rh/payrollLoan/v1/registrations/authorizedUsePersonalData

Description

Método para consulta da autorização de dados pessoais.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

GET
rh/payrollLoan/v1/banks

Description

Método para consulta de bancos.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
filter string optional

GET
rh/payrollLoan/v1/loanRequests/{status}

Description

Método para consulta de status das solicitações de empréstimo.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page integer optional
pagesize integer optional
order string optional

GET
rh/payrollLoan/v1/payrollLoans/{contractId}/installments/{installmentId}

Description

Método que retorna os detalhes da parcela de empréstimo.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

GET
rh/payrollLoan/v1/blobStorage/signedUrl/identificationDocument

Description

Solicita uma URL assinada pelo MeuRH

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
loanrequestid string required
filetype string optional
documenttype integer optional
documentside integer optional

GET
rh/payrollLoan/v1/payrollLoans/{contractId}/installments

Description

Método para obter a listagem simples de parcelas do contrato.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page integer optional
pagesize integer optional
order string optional

GET
rh/payrollLoan/v1/loanRequests/{id}/detail

Description

Método para obter o detalhamento da solicitação de empréstimo.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

GET
rh/payrollLoan/v1/payrollLoans

Description

Método para listagem de empréstimos

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

GET
rh/payrollLoan/v1/person/{type}/documentType

Description

Consulta a existência do tipo de documento da pessoa

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

GET
rh/payrollLoan/v1/registrations/status

Description

Método para autorizar o uso de dados pessoais.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

GET
rh/payrollLoan/v1/blobStorage/signedUrl/residenceProof

Description

Solicita uma URL assinada pelo MeuRH para o tipo de arquivo

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
loanrequestid string required
filetype string optional

GET
rh/payrollLoan/v1/loanRequests/status/count

Description

Método para consulta da quantidade de solicitações de empréstimos por status.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

GET
rh/payrollLoan/v1/payrollLoans/{contractId}/statement

Description

Método para obter o extrato do contrato.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

GET
rh/payrollLoan/v1/loanRequests/{id}/terms

Description

Método para consultar os termos da solicitação de empréstimo.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

GET
rh/payrollLoan/v1/payrollLoans/totalAmountBorrowed/user

Description

Método para consulta de valor total emprestado.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

GET
rh/payrollLoan/v1/loanRequests/{id}/getTermsUrlDownload

Description

Método para consultar a lista de termos com suas respectivas URLs assinadas.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

GET
rh/payrollLoan/v1/loanRequests/policy/validate

Description

Método para validar a política da solicitação de empréstimo.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
installmentquantity integer required
installmentvalue integer required

POST
rh/payrollLoan/v1/loanRequests

Description

Método para enviar a solicitação de empréstimo.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
rh/payrollLoan/v1/simulation/execute

Description

Método para executar a simulação.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

PUT
rh/payrollLoan/v1/person/address

Description

Atualiza o endereço da pessoa

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

PUT
rh/payrollLoan/v1/registrations/authorizeUsePersonalData

Description

Método para autorizar o uso de dados pessoais.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

PUT
rh/payrollLoan/v1/loanRequests/{id}/documents

Description

Atualiza o documento da Solicitação de Empréstimo.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

PUT
rh/payrollLoan/v1/registrations/revokeUsePersonalData

Description

Método revogar uso de dados pessoais.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

PUT
rh/payrollLoan/v1/loanRequests/{id}/terms/signature

Description

Realiza a assinatura do contrato da Solicitação de Empréstimo.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined