{"info":{"_postman_id":"05e55102-ebdf-467f-abef-084a6471bf09","name":"Allgoo API Advisor Previdência","description":"Esta é a nossa documentação da API do Robô Advisor Previdência.\n\nTodas as consultas consomem e retornam conteúdos JSON (application/json).\n\n**USO DA API**\n\nPara implementação da API em seu sitema, selecione na coluna ao lado a linguagem de programação que gostaria de usar para fazer requisições aos endpoints. Códigos de exemplo serão gerados ao lado de cada endpoint para auxiliá-lo na implementação.\nPara uma implementação alternativa da API, utilize o Postman clicando em *Run in Postman*.\n\nDisponibilizamos uma interface gráfica para você ver o funcionamento da nossa API. O link é o: https://apis.allgoo.com.br/advisor/v2/pension.\n\nA seguir serão listadas algumas observações, parâmetros de entrada, exemplo de retorno e cenários utilizando a nossa API.\n\n**OBSERVAÇÕES**\n\n- Para a simulação e execução de carteiras é necessário que você cadastre os produtos da sua instituição financeira utilizando nossa API de Produtos. O link da documentação é: https://documenter.getpostman.com/view/2843755/produtos/RVfzeTig\n- Nossa API do Advisor Previdência considera os prazos em meses.\n- Clique nas tabelas/imagens para visualizar todas as informações.\n\n**PARÂMETROS DE ENTRADA**\n\nVocê deve enviar sua API Key no Header como ```x-api-key``` e os seguintes parâmetros no Body:\n\n| Chave | Descrição | Tipo | Default |\n| ------ | ------ | ------ | ------ |\n| current_age* | Idade atual | Integer | - |\n| retirement_age* | Idade de aposentadoria | Integer | - |\n| life_expectancy | Expectativa de vida | Integer | 100 |\n| monthly_retirement_income* | Renda Mensal durante a aposentadoria | Float | - |\n| initial_capital* | Capital Inicial | Float | - |\n| investment_profile* | Perfil de Investidor | String | - |\n| name* | Nome para a carteira | String | - |\n| investment_period* ¹ | Investimento Mensal | Float | - |\n| max_deadline | Prazo máximo que a API utilizará para sugerir carteiras | Integer | 999 |\n| deduce_income_tax* | Deduzir Imposto de Renda? (S/N) | String | - |\n| full_percentage_cdi* | Produtos Renda Fixa e COE com 100% CDI? (S/N) | String | - |\n| agroup_fixed_incomes* | Agrupar Produtos Renda Fixa em um único produto? (S/N) | String | - |\n| agroup_products ² | Agrupar produtos por Classe de Ativo? (S/N) | String | N |\n| pension_plan | Plano de Previdência (PGBL/VGBL) | String | VGBL |\n| pension_table | Tabela de Previdência (progressiva/regressiva) | String | regressiva |\n| old_response | Flag que indica se deseja o retorno no formato v1 da API | String | N |\n\n( * ) campo obrigatório\n\n( 1 ) Caso seja enviado capital mensal (investment_period) do objetivo e for diferente de 0 (zero) e null, será considerado que o objetivo possui capital mensal.\n\n( 2 ) Caso seja enviado **agroup_products** como **S** e **agroup_fixed_incomes** como **N**, o retorno do **financial_assets** será um JSON ao invés de uma lista.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Exemplo 1","item":[{"name":"Exemplo 1","id":"8549a0df-25bd-49fe-a04c-686e5a2b9900","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"<sua api_key>"}],"body":{"mode":"raw","raw":"{\r\n\t\"name\": \"Exemplo 1\",\r\n\t\r\n\t\"current_age\": 22,\r\n\t\"retirement_age\": 67,\r\n\t\"monthly_retirement_income\": 6500,\r\n\t\"initial_capital\": 50000,\r\n\t\"investment_period\": 3000,\r\n\t\r\n\t\"pension_plan\": \"PGBL\",\r\n\t\"pension_table\": \"progressiva\",\r\n\t\r\n\t\"deduce_income_tax\": \"S\",\r\n\t\"full_percentage_cdi\": \"S\",\r\n\t\"agroup_fixed_incomes\": \"S\",\r\n\t\"investment_profile\": \"agressivo\"\r\n}"},"url":"https://apis.allgoo.com.br/advisor/v2/pension"},"response":[],"_postman_id":"8549a0df-25bd-49fe-a04c-686e5a2b9900"}],"id":"b92208bd-fdea-491b-bee7-9de2b8ab94b5","description":"Este exemplo consiste no seguinte cenário e parâmetros:\n\nCliente com perfil agressivo possui 22 anos de idade e deseja aposentar com 67 anos com renda mensal de R$ 6500. Para isso ele aplicará inicialmente R$50000 e mensalmente R$3000. Os outros campos indicam que o plano e tabela da previdência são respectivatmente PGBL e progressiva. Além disso, será deduzido o imposto de renda no final do investimento.\n\n- Nome da Carteira: **Exemplo 1**\n- Perfil de Investidor: **agressivo**\n- Idade atual: **22**\n- Idade aposentadoria: **67**\n- Renda mensal aposentadoria: **R$ 6500**\n- Capital inicial: **R$ 50000**\n- Capital mensal: **R$ 3000**\n- Plano previdência: **PGBL**\n- Tabela previdência: **progressiva**\n- Deduzir IR: **Sim**\n- Produtos Renda Fixa e COE com 100% CDI: **Sim**\n- Agrupar Produtos Renda Fixa: **Sim**","event":[{"listen":"prerequest","script":{"id":"989e5da7-5df4-4ec3-bec5-8697b82a2ae6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3ddd5511-e8ac-470f-95af-46b86eeed5ec","type":"text/javascript","exec":[""]}}],"_postman_id":"b92208bd-fdea-491b-bee7-9de2b8ab94b5"},{"name":"Exemplo 2","item":[{"name":"Exemplo 2","id":"344d356d-9863-4562-9794-3f9125d6e234","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"<sua api_key>"}],"body":{"mode":"raw","raw":"{\r\n\t\"name\": \"Exemplo 2\",\r\n\t\"investment_profile\": \"conservador\",\r\n\t\r\n\t\"current_age\": 35,\r\n\t\"retirement_age\": 82,\r\n\t\r\n\t\"life_expectancy\": 90,\r\n\t\r\n\t\"monthly_retirement_income\": 12560,\r\n\t\"initial_capital\": 1000,\r\n\t\"investment_period\": 8000,\r\n\t\r\n\t\"deduce_income_tax\": \"N\",\r\n\t\"full_percentage_cdi\": \"S\",\r\n\t\"agroup_fixed_incomes\": \"N\",\r\n\t\"agroup_products\": \"S\",\r\n\t\"max_deadline\": 600,\r\n\t\"old_response\": \"S\"\r\n}"},"url":"https://apis.allgoo.com.br/advisor/v2/pension"},"response":[],"_postman_id":"344d356d-9863-4562-9794-3f9125d6e234"}],"id":"da3438f0-2e64-436a-82a6-76fce2e61757","description":"Este exemplo consiste no seguinte cenário e parâmetros:\n\nCliente com perfil conservador possui 35 anos de idade e deseja aposentar com 82 anos com renda mensal de R$ 12560, sendo a expectativa de vida de 90 anos. Para isso ele aplicará inicialmente R$1000 e mensalmente R$8000. Os outros campos indicam que não será deduzido o imposto de renda no final do investimento e o prazo máximo para a carteira são 600 meses.\n\n- Nome da Carteira: **Exemplo 2**\n- Perfil de Investidor: **conservador**\n- Idade atual: **35**\n- Idade aposentadoria: **82**\n- Expectativa de vida: **90**\n- Renda mensal aposentadoria: **R$ 12560**\n- Capital inicial: **R$ 1000**\n- Capital mensal: **R$ 8000**\n- Deduzir IR: **Não**\n- Produtos Renda Fixa e COE com 100% CDI: **Sim**\n- Agrupar Produtos Renda Fixa: **Não**\n- Agrupar produtos por Classe de Ativo: **Sim**","event":[{"listen":"prerequest","script":{"id":"0a52874a-8e90-4e75-aa97-84a21a55588d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a9a6043f-1959-4551-9bd6-6f0428f7bffd","type":"text/javascript","exec":[""]}}],"_postman_id":"da3438f0-2e64-436a-82a6-76fce2e61757"}],"event":[{"listen":"prerequest","script":{"id":"c21834c4-8696-4c1c-87a4-881b7707d3d4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"abbcda63-5854-45d7-af04-c57ab1265320","type":"text/javascript","exec":[""]}}]}