CONTEÚDO
- Visão Geral
- Modelo de Integração
- Exemplo API
- Exemplo Informe de Rendimento
01. VISÃO GERAL
Esta funcionalidade permite que sistemas terceiros, ou outros sistemas Core Banking, disponibilizem os informes de rendimentos gerados pelo sistema DIRF Core Banking.
02. MODELO INTEGRAÇÃO
03. EXEMPLO API
DirfService
API de serviços do sistema DIRF
GET
consultarInformeRendimento
Serviço responsável por retornar o PDF do Informe de rendimentos gerado pelo sistema da DIRF.
Request Headers
Authorization
bearer <bearer token obtido através da autenticação no serviço Keyckloak>
Request Params
periodo: Parâmetro que indica o período do Informe, DOMÍNIO (AA - Anual, T1 – Primeiro Trimestre, T2 – Segundo Trimestre, T3 – Terceiro Trimestre e T4 – Quarto Trimestre)
documento: Parâmetro de identificação do cliente CPF ou CNPJ
anoExercicio: Parâmetro que indica o ano de exercício do informe de rendimentos.
Exemplo de Request:
http://<IPSERVER>:<PORTA>/tfs-ibankingdirf-service/rest/dirf/consultarInformeRendimento?periodo=AA&documento=00000000000&anoExercicio=2020
curl --location --request GET 'http://<IPSERVER>:<PORTA>/tfs-ibankingdirf-service/rest/dirf/consultarInformeRendimento?periodo=AA&documento=00000000000&anoExercicio=2020' --header 'Authorization: Bearer kjalksdjflakjsdlfkjalsdkjflaksdjflkajsldkfjalskdjfkajsdlkfjalsdkjflaksjdfkajsdlkfjalsdkjflaskdjflkajsldkfjaeiw...'
Exemplo de Response:
Sucesso:
{
"success": true,
"content": {
"id": 66,
"nomeDiretorio": "c:\\temp\\",
"nomeArquivo": "00000000000_2020AA",
"representacaoBinaria": "JVBERi0xLjcKJcfsj6IKJSVJbnZvY2F0aW9..."
}
}
Erro:
{
"success": false,
"message": "Informe de Rendimentos indisponível para o período selecionado"
}