Advisor Service API Reference

Bem-vindo à Allgoo! Esta é a nossa documentação do Advisor Service e Track Balance Service.

Os endpoints incluem a sugestão de novas carteiras, follow (track-balance) das carteiras já existentes e outros já disponíveis para algumas jornadas, como por exemplo, saldo parado em conta.

  • 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. Por favor consulte as seções Produto Fundos de Investimento, Produto Título Renda Fixa, Produto COE, Produto Tesouro Direto.
  • Todos os endpoints consideram os prazos em meses.
API Endpoint
https://apis.allgoo.com.br/advisor/
Contact: contato@allgoo.com.br
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https

Simulador

Endpoints responsáveis pela simulação com/sem meta financeira e verificação de quanto teria rendido se tivesse investido.

Sugestão de Carteira

POST /v2.3

Neste endpoint você conseguirá realizar simulações com e sem meta financeira. A API retornará sempre uma sugestão de carteira levando em consideração a última parametrização cadastrada.

Request body

x-api-key: string
in header

api key

Request Content-Types: application/json
Request Example
{
  "agroup_fixed_incomes": "string",
  "agroup_products": "string",
  "deadline": "integer",
  "deduce_income_tax": "string",
  "financial_goal": "number",
  "full_percentage_cdi": "string",
  "initial_capital": "number",
  "investment_period": "number",
  "investment_profile": "string",
  "save_investment": "string",
  "max_deadline": "integer",
  "name": "string",
  "only_projections": "string",
  "lock_deadline": "string",
  "closest_due_date": "string"
}
201 Created

Carteira sugerida e mais informações

400 Bad Request

Invalid type in request data

Response Content-Types: application/json
Response Example (201 Created)
{
  "capital_invest": "number",
  "deadline": "integer",
  "financial_goal": "number",
  "initial_capital": "number",
  "investment_period": "number",
  "message": "string",
  "success": "boolean",
  "indexers": [
    {
      "name": "string",
      "rate": "string"
    }
  ],
  "investment_goal": {
    "id": "string",
    "name": "string"
  },
  "recurring_product": [
    {
      "allocation": "number",
      "deadline_fixed_income": "string",
      "disclaimer": "string",
      "fee_fixed_income": "string",
      "financial_balance": "number",
      "id": "string",
      "minimum_value": "number",
      "name": "string",
      "percentage": "string",
      "risk": "string",
      "type": "string"
    }
  ],
  "projections": [
    {
      "benchmarks": "object",
      "benchmarks_class_product": "object",
      "products": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "capital_invest": "number",
      "deadline_achive_goal": "integer",
      "gross_value": "number",
      "name": "string",
      "net_value": "number",
      "value_achive_goal": "number",
      "projections": "array"
    }
  ]
}

Se tivesse investido

POST /v2/track-balance/simulator

Endpoint responsável pela verificação de quanto teria rendido desde o dia da simulação e sugestão de uma nova carteira. Considera como capital inicial para a nova carteira o valor do capital inicial informado nos dados do simulador.

x-api-key: string
in header

api key

Request Content-Types: application/json
Request Example
{
  "client_id": "string",
  "account_balance": "string",
  "investment_profile": "string",
  "new_response": "boolean",
  "simulation": {
    "agroup_fixed_incomes": "string",
    "agroup_products": "string",
    "deadline": "integer",
    "deduce_income_tax": "string",
    "financial_goal": "number",
    "full_percentage_cdi": "string",
    "initial_capital": "number",
    "investment_period": "number",
    "investment_profile": "string",
    "save_investment": "string",
    "max_deadline": "integer",
    "name": "string",
    "only_projections": "string",
    "simulation_date": "date"
  },
  "products": [
    {
      "id": "string",
      "balance": "number",
      "investment_date": "date (DD/MM/YYYY)",
      "name": "string",
      "fixed_incomes": "boolean",
      "type": "string",
      "indexer": "string",
      "fee": "number",
      "daily_liquidity": "boolean",
      "deadline": "integer"
    }
  ]
}
201 Created

Carteira sugerida e mais informações

Response Content-Types: application/json
Response Example (201 Created)
{
  "capital_invest": "number",
  "deadline": "integer",
  "financial_goal": "number",
  "initial_capital": "number",
  "investment_period": "number",
  "message": "string",
  "success": "boolean",
  "indexers": [
    {
      "name": "string",
      "rate": "string"
    }
  ],
  "investment_goal": {
    "id": "string",
    "name": "string"
  },
  "recurring_product": [
    {
      "allocation": "number",
      "deadline_fixed_income": "string",
      "disclaimer": "string",
      "fee_fixed_income": "string",
      "financial_balance": "number",
      "id": "string",
      "minimum_value": "number",
      "name": "string",
      "percentage": "string",
      "risk": "string",
      "type": "string"
    }
  ],
  "projections": [
    {
      "benchmarks": "object",
      "benchmarks_class_product": "object",
      "products": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "capital_invest": "number",
      "deadline_achive_goal": "integer",
      "gross_value": "number",
      "name": "string",
      "net_value": "number",
      "value_achive_goal": "number",
      "projections": "array"
    }
  ]
}

Previdência Privada

POST /pension

Endpoint responsável pela simulação com meta financeira no cenário de previdência privada.

x-api-key: string
in header

api key

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "current_age": "integer",
  "retirement_age": "integer",
  "life_expectancy": "integer",
  "monthly_retirement_income": "number",
  "initial_capital": "number",
  "investment_profile": "string",
  "investment_period": "number",
  "max_deadline": "integer",
  "agroup_fixed_incomes": "string",
  "agroup_products": "string",
  "deduce_income_tax": "string",
  "full_percentage_cdi": "string",
  "pension_plan": "string",
  "pension_table": "string"
}
201 Created

Carteira sugerida e mais informações

Response Content-Types: application/json
Response Example (201 Created)
{
  "capital_invest": "number",
  "deadline": "integer",
  "financial_goal": "number",
  "initial_capital": "number",
  "investment_period": "number",
  "message": "string",
  "success": "boolean",
  "indexers": [
    {
      "name": "string",
      "rate": "string"
    }
  ],
  "investment_goal": "object",
  "pension_indication": "object",
  "recurring_product": [
    {
      "allocation": "number",
      "deadline_fixed_income": "string",
      "disclaimer": "string",
      "fee_fixed_income": "string",
      "financial_balance": "number",
      "id": "string",
      "minimum_value": "number",
      "name": "string",
      "percentage": "string",
      "risk": "string",
      "type": "string"
    }
  ],
  "projections": [
    {
      "deadline_achive_goal_formatted": "object",
      "products": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "capital_invest": "number",
      "deadline_achive_goal": "integer",
      "gross_value": "number",
      "name": "string",
      "net_value": "number",
      "value_achive_goal": "number",
      "projections": "array"
    }
  ]
}

Track Balance

Endpoint responsável pelo rebalanceamento e redistribuição da carteira e enquadramento do perfil de investidor, levando-se em consideração a última parametrização cadastrada.

Track Balance

POST /v3/balance

Request body

x-api-key: string
in header

api key

Request Content-Types: application/json
Request Example
{
  "client_id": "string",
  "investment_profile": "string",
  "rescue_automatic": "boolean",
  "investments": [
    {
      "id": "string",
      "name": "string",
      "deadline": "integer",
      "deduce_income_tax": "string",
      "deduce_quota_eating": "string",
      "financial_goal": "number",
      "full_percentage_cdi": "string",
      "initial_capital": "number",
      "investment_period": "number",
      "max_deadline": "integer",
      "lock_deadline": "string",
      "closest_due_date": "string",
      "products": [
        {
          "id": "string",
          "initial_capital": "number",
          "investment_date": "date (DD/MM/YYYY)",
          "name": "string",
          "fixed_incomes": "boolean",
          "type": "string",
          "indexer": "string",
          "fee": "number",
          "daily_liquidity": "boolean",
          "deadline": "integer",
          "minimum_value": "number",
          "add": [
            {
              "value": "number",
              "date": "number"
            }
          ],
          "rescue": [
            {
              "value": "number",
              "date": "number"
            }
          ]
        }
      ]
    }
  ],
  "products": [
    {
      "id": "string",
      "balance": "number",
      "investment_date": "date (DD/MM/YYYY)",
      "name": "string",
      "fixed_incomes": "boolean",
      "type": "string",
      "indexer": "string",
      "fee": "number",
      "daily_liquidity": "boolean",
      "deadline": "integer",
      "minimum_value": "number"
    }
  ]
}
201 Created

Carteira sugerida e mais informações

400 Bad Request

Invalid type in request data

Response Content-Types: application/json
Response Example (201 Created)
{
  "success": "boolean",
  "message": "string",
  "redistribuitions": [
    {
      "products": [
        {
          "added": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ],
          "assets": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ],
          "invested": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ],
          "rescued": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ]
        }
      ],
      "projections": "array",
      "value_achive_goal": "number",
      "deadline_achive_goal": "integer",
      "gross_value": "number",
      "name": "string",
      "net_value": "number"
    }
  ]
}

Rentabilidade

Endpoint responsável pelo cálculo de rentabilidade de uma ou mais carteiras. A rentabilidade pode ser retornada agrupadas por 'mês' ou por 'dia'.

Rentabilidade

POST /v3/rentability

Request body

x-api-key: string
in header

api key

Request Content-Types: application/json
Request Example
{
  "client_id": "string",
  "investment_profile": "string",
  "group_by": "string",
  "rescue_automatic": "boolean",
  "gross_up": "boolean",
  "benchmarks": [
    "string"
  ],
  "investments": [
    {
      "id": "string",
      "name": "string",
      "deadline": "integer",
      "deduce_income_tax": "string",
      "deduce_quota_eating": "string",
      "financial_goal": "number",
      "full_percentage_cdi": "string",
      "initial_capital": "number",
      "investment_period": "number",
      "max_deadline": "integer",
      "lock_deadline": "string",
      "closest_due_date": "string",
      "products": [
        {
          "id": "string",
          "initial_capital": "number",
          "investment_date": "date (DD/MM/YYYY)",
          "name": "string",
          "fixed_incomes": "boolean",
          "type": "string",
          "indexer": "string",
          "fee": "number",
          "daily_liquidity": "boolean",
          "deadline": "integer",
          "minimum_value": "number",
          "add": [
            {
              "value": "number",
              "date": "number"
            }
          ],
          "rescue": [
            {
              "value": "number",
              "date": "number"
            }
          ]
        }
      ]
    }
  ],
  "products": [
    {
      "id": "string",
      "balance": "number",
      "investment_date": "date (DD/MM/YYYY)",
      "name": "string",
      "fixed_incomes": "boolean",
      "type": "string",
      "indexer": "string",
      "fee": "number",
      "daily_liquidity": "boolean",
      "deadline": "integer",
      "minimum_value": "number"
    }
  ],
  "start_date": "date (DD/MM/YYYY)",
  "last_date": "date (DD/MM/YYYY)"
}
201 Created

Carteira sugerida e mais informações

400 Bad Request

Invalid type in request data

Response Content-Types: application/json
Response Example (201 Created)
{
  "benchmarks": {
    "CDI": [
      {
        "date": "4/2019",
        "percentage": "181.87%"
      },
      {
        "date": "5/2019",
        "percentage": "202.33%"
      }
    ],
    "IBOVESPA": [
      {
        "date": "4/2019",
        "percentage": "89.16%"
      },
      {
        "date": "5/2019",
        "percentage": "96.01%"
      }
    ]
  },
  "client_id": "123",
  "gain": [
    {
      "date": "4/2019",
      "percentage": "0.94%",
      "value": 333.46721884113686
    },
    {
      "date": "5/2019",
      "percentage": "0.73%",
      "value": 266.0375706535997
    }
  ],
  "gross_value_accumulated": 59475.85607379695,
  "initial_capital": 35000,
  "investment_capital": 48000,
  "rentabilities_investments": [
    {
      "accumulated_mensal_capital": 13000,
      "benchmarks": {
        "CDI": [
          {
            "date": "4/2019",
            "percentage": "181.87%"
          },
          {
            "date": "5/2019",
            "percentage": "202.33%"
          }
        ],
        "IBOVESPA": [
          {
            "date": "4/2019",
            "percentage": "89.16%"
          },
          {
            "date": "5/2019",
            "percentage": "96.01%"
          }
        ]
      },
      "benchmarks_class_product": {
        "Fundos de Investimentos": {
          "benchmarks": {
            "CDI": [
              {
                "date": "4/2019",
                "percentage": "300.46%"
              },
              {
                "date": "5/2019",
                "percentage": "355.01%"
              }
            ],
            "IBOVESPA": [
              {
                "date": "4/2019",
                "percentage": "147.3%"
              },
              {
                "date": "5/2019",
                "percentage": "168.47%"
              }
            ]
          },
          "classes": {
            "Ações": {
              "benchmarks": {
                "CDI": [
                  {
                    "date": "4/2019",
                    "percentage": "300.46%"
                  },
                  {
                    "date": "5/2019",
                    "percentage": "355.01%"
                  }
                ],
                "IBOVESPA": [
                  {
                    "date": "4/2019",
                    "percentage": "147.3%"
                  },
                  {
                    "date": "5/2019",
                    "percentage": "168.47%"
                  }
                ]
              },
              "gain": [
                {
                  "date": "4/2019",
                  "percentage": "1.56%",
                  "value": 211.87113055468762
                },
                {
                  "date": "5/2019",
                  "percentage": "1.28%",
                  "value": 178.56326216553498
                }
              ]
            }
          },
          "gain": [
            {
              "date": "4/2019",
              "percentage": "1.56%",
              "value": 211.87113055468762
            },
            {
              "date": "5/2019",
              "percentage": "1.28%",
              "value": 178.56326216553498
            }
          ]
        },
        "Título de Renda Fixa": {
          "benchmarks": {
            "CDI": [
              {
                "date": "4/2019",
                "percentage": "107.76%"
              },
              {
                "date": "5/2019",
                "percentage": "107.74%"
              }
            ],
            "IBOVESPA": [
              {
                "date": "4/2019",
                "percentage": "52.83%"
              },
              {
                "date": "5/2019",
                "percentage": "51.13%"
              }
            ]
          },
          "classes": {
            "Pós-fixado": {
              "benchmarks": {
                "CDI": [
                  {
                    "date": "4/2019",
                    "percentage": "107.76%"
                  },
                  {
                    "date": "5/2019",
                    "percentage": "107.74%"
                  }
                ],
                "IBOVESPA": [
                  {
                    "date": "4/2019",
                    "percentage": "52.83%"
                  },
                  {
                    "date": "5/2019",
                    "percentage": "51.13%"
                  }
                ]
              },
              "gain": [
                {
                  "date": "4/2019",
                  "percentage": "0.56%",
                  "value": 121.59608828644923
                },
                {
                  "date": "5/2019",
                  "percentage": "0.39%",
                  "value": 87.47430848806471
                }
              ]
            }
          },
          "gain": [
            {
              "date": "4/2019",
              "percentage": "0.56%",
              "value": 121.59608828644923
            },
            {
              "date": "5/2019",
              "percentage": "0.39%",
              "value": 87.47430848806471
            }
          ]
        }
      },
      "gain": [
        {
          "date": "4/2019",
          "percentage": "0.94%",
          "value": 333.46721884113686
        },
        {
          "date": "5/2019",
          "percentage": "0.73%",
          "value": 266.0375706535997
        }
      ],
      "gross_value_accumulated": 59475.85607379695,
      "id": "1",
      "initial_capital": 35000,
      "investment_capital": 48000,
      "name": "casa",
      "rentabilities_product": [
        {
          "balance": 13995.645136522511,
          "gain": {
            "percent": "2.87%",
            "value": 390.43439272022
          },
          "group_by": "MES",
          "id": "199567",
          "initial_capital": 5000,
          "investment_capital": 5000,
          "investment_date": "01/11/2016",
          "name": "GTI Dimona Brasil FIA",
          "rentabilities": [
            {
              "add": 0,
              "benchmarks": {
                "CDI": "300.46%",
                "IBOVESPA": "147.3%"
              },
              "date": "4/2019",
              "deadline": 0,
              "gain": {
                "percent": "1.56%",
                "value": 211.87113055468762
              },
              "mensal_capital": 0,
              "rescue": 0,
              "value_accumulated": 13817.081874356976
            },
            {
              "add": 0,
              "benchmarks": {
                "CDI": "355.01%",
                "IBOVESPA": "168.47%"
              },
              "date": "5/2019",
              "deadline": 1,
              "gain": {
                "percent": "1.28%",
                "value": 178.56326216553498
              },
              "mensal_capital": 0,
              "rescue": 0,
              "value_accumulated": 13995.645136522511
            }
          ],
          "value_accumulated": 13995.645136522511
        },
        {
          "balance": 22480.210937274445,
          "daily_liquidity": false,
          "deadline": 60,
          "fee": 108,
          "fixed_incomes": true,
          "gain": {
            "percent": "0.94%",
            "value": 209.07039677451
          },
          "group_by": "MES",
          "id": "0",
          "indexer": "CDI",
          "initial_capital": 7000,
          "investment_capital": 20000,
          "investment_date": "05/02/2017",
          "minimum_value": 1,
          "name": "CDB CDI",
          "recurring_product": true,
          "rentabilities": [
            {
              "add": 0,
              "benchmarks": {
                "CDI": "107.76%",
                "IBOVESPA": "52.83%"
              },
              "date": "4/2019",
              "deadline": 0,
              "gain": {
                "percent": "0.55%",
                "value": 121.59608828644923
              },
              "mensal_capital": 500,
              "rescue": 0,
              "value_accumulated": 22392.73662878638
            },
            {
              "add": 0,
              "benchmarks": {
                "CDI": "107.74%",
                "IBOVESPA": "51.13%"
              },
              "date": "5/2019",
              "deadline": 1,
              "gain": {
                "percent": "0.39%",
                "value": 87.47430848806471
              },
              "mensal_capital": 0,
              "rescue": 0,
              "value_accumulated": 22480.210937274445
            }
          ],
          "type": "POS",
          "value_accumulated": 22480.210937274445
        }
      ],
      "rescue_accumulated": 0
    }
  ]
}

Aporte Adicional Inteligente

Endpoints responsáveis pelo aporte adicional em uma/múltiplas carteiras.

Inteligente

POST /v3/add

Endpoint responsável pelo aporte inteligente em um ou mais produtos de um cliente. Ele é responsável por indentificar o melhor cenário para inserção de um recurso nos investimentos, visando a aceleração dos objetivos.

Request body

x-api-key: string
in header

api key

Request Content-Types: application/json
Request Example
{
  "client_id": "string",
  "investment_profile": "string",
  "new_response": "boolean",
  "new_financial_resource": "number",
  "benchmarks": [
    "string"
  ],
  "investments": [
    {
      "id": "string",
      "name": "string",
      "deadline": "integer",
      "deduce_income_tax": "string",
      "financial_goal": "number",
      "full_percentage_cdi": "string",
      "initial_capital": "number",
      "investment_period": "number",
      "max_deadline": "integer",
      "lock_deadline": "string",
      "closest_due_date": "string",
      "products": [
        {
          "id": "string",
          "initial_capital": "number",
          "investment_date": "date (DD/MM/YYYY)",
          "name": "string",
          "fixed_incomes": "boolean",
          "type": "string",
          "indexer": "string",
          "fee": "number",
          "daily_liquidity": "boolean",
          "deadline": "integer",
          "minimum_value": "number"
        }
      ]
    }
  ],
  "products": [
    {
      "id": "string",
      "balance": "number",
      "investment_date": "date (DD/MM/YYYY)",
      "name": "string",
      "fixed_incomes": "boolean",
      "type": "string",
      "indexer": "string",
      "fee": "number",
      "daily_liquidity": "boolean",
      "deadline": "integer",
      "minimum_value": "number"
    }
  ]
}
201 Created

Carteira sugerida e mais informações

400 Bad Request

Invalid type in request data

Response Content-Types: application/json
Response Example (201 Created)
{
  "capital_invest": "number",
  "deadline": "integer",
  "financial_goal": "number",
  "indexers": [
    {
      "name": "string",
      "rate": "string"
    }
  ],
  "initial_capital": "number",
  "investment_period": "number",
  "message": "string",
  "success": "boolean",
  "best_investment": "string",
  "recurring_product": [
    {
      "allocation": "number",
      "deadline_fixed_income": "string",
      "disclaimer": "string",
      "fee_fixed_income": "string",
      "financial_balance": "number",
      "id": "string",
      "minimum_value": "number",
      "name": "string",
      "percentage": "string",
      "risk": "string",
      "type": "string"
    }
  ],
  "projections": [
    {
      "benchmarks": "object",
      "benchmarks_class_product": "object",
      "products": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "capital_invest": "number",
      "deadline_achive_goal": "integer",
      "gross_value": "number",
      "name": "string",
      "net_value": "number",
      "value_achive_goal": "number",
      "projections": "array"
    }
  ],
  "benchmarks": "array",
  "benchmarks_class_product": "array",
  "new_benchmarks": "array",
  "new_benchmarks_class_product": "array"
}

Única carteira

POST /v2/add

Endpoint responsável pelo aporte inteligente em um ou mais produtos de um cliente, não realizando rebalanceamento e redistribuição.

Ele é responsável por indentificar o melhor cenário para inserção de um recurso nos investimentos, visando a aceleração dos objetivos.

Request body

x-api-key: string
in header

api key

Request Content-Types: application/json
Request Example
{
  "client_id": "string",
  "investment_profile": "string",
  "new_response": "boolean",
  "new_financial_resource": "number",
  "benchmarks": [
    "string"
  ],
  "agroup_fixed_incomes": "number",
  "account_balance": "string",
  "investments": {
    "name": "string",
    "deadline": "integer",
    "financial_goal": "number",
    "initial_capital": "number",
    "investment_period": "number",
    "balance": "number"
  },
  "products": [
    {
      "id": "string",
      "balance": "number",
      "investment_date": "date (DD/MM/YYYY)",
      "name": "string",
      "fixed_incomes": "boolean",
      "type": "string",
      "indexer": "string",
      "fee": "number",
      "daily_liquidity": "boolean",
      "deadline": "integer",
      "minimum_value": "number"
    }
  ],
  "deduce_income_tax": "string",
  "max_deadline": "integer"
}
201 Created

Carteira sugerida e mais informações

400 Bad Request

Invalid type in request data

Response Content-Types: application/json
Response Example (201 Created)
{
  "capital_invest": "number",
  "deadline": "integer",
  "financial_goal": "number",
  "indexers": [
    {
      "name": "string",
      "rate": "string"
    }
  ],
  "initial_capital": "number",
  "investment_period": "number",
  "message": "string",
  "success": "boolean",
  "investment_goal": "object",
  "recurring_product": [
    {
      "allocation": "number",
      "deadline_fixed_income": "string",
      "disclaimer": "string",
      "fee_fixed_income": "string",
      "financial_balance": "number",
      "id": "string",
      "minimum_value": "number",
      "name": "string",
      "percentage": "string",
      "risk": "string",
      "type": "string"
    }
  ],
  "projections": [
    {
      "benchmarks": "object",
      "benchmarks_class_product": "object",
      "products": [
        {
          "added": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ],
          "assets": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ],
          "invested": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ],
          "rescued": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object"
            }
          ]
        }
      ]
    }
  ]
}

Única carteira com sugestão de resgate Liquidez Diária.

POST /v2/rebalance

Endpoint responsável pelo aporte inteligente em um ou mais produtos de um cliente, não realizando rebalanceamento e redistribuição.

Ele é responsável por indentificar o melhor cenário para inserção de um recurso nos investimentos, visando a aceleração dos objetivos, levando em consideração possíveis resgates nos produtos Liquidez Diária.

Request body

x-api-key: string
in header

api key

Request Content-Types: application/json
Request Example
{
  "client_id": "string",
  "investment_profile": "string",
  "new_response": "boolean",
  "new_financial_resource": "number",
  "benchmarks": [
    "string"
  ],
  "agroup_fixed_incomes": "number",
  "account_balance": "string",
  "investments": {
    "name": "string",
    "deadline": "integer",
    "financial_goal": "number",
    "initial_capital": "number",
    "investment_period": "number",
    "balance": "number"
  },
  "products": [
    {
      "id": "string",
      "balance": "number",
      "investment_date": "date (DD/MM/YYYY)",
      "name": "string",
      "fixed_incomes": "boolean",
      "type": "string",
      "indexer": "string",
      "fee": "number",
      "daily_liquidity": "boolean",
      "deadline": "integer",
      "minimum_value": "number"
    }
  ],
  "deduce_income_tax": "string",
  "max_deadline": "integer"
}
201 Created

Carteira sugerida e mais informações

400 Bad Request

Invalid type in request data

Response Content-Types: application/json
Response Example (201 Created)
{
  "capital_invest": "number",
  "deadline": "integer",
  "financial_goal": "number",
  "indexers": [
    {
      "name": "string",
      "rate": "string"
    }
  ],
  "initial_capital": "number",
  "investment_period": "number",
  "message": "string",
  "success": "boolean",
  "investment_goal": "object",
  "recurring_product": [
    {
      "allocation": "number",
      "deadline_fixed_income": "string",
      "disclaimer": "string",
      "fee_fixed_income": "string",
      "financial_balance": "number",
      "id": "string",
      "minimum_value": "number",
      "name": "string",
      "percentage": "string",
      "risk": "string",
      "type": "string"
    }
  ],
  "projections": [
    {
      "benchmarks": "object",
      "benchmarks_class_product": "object",
      "products": [
        {
          "added": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ],
          "assets": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ],
          "invested": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ],
          "rescued": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object"
            }
          ]
        }
      ]
    }
  ]
}

Saldo parado conta corrente

POST /v2/track-balance/financial-goal/account-balance

Endpoint responsável pela jornada de saldo parado em conta corrente. Considera como capital inicial da nova carteira o saldo da conta corrente atual do cliente.

x-api-key: string
in header

api key

Request Content-Types: application/json
Request Example
{
  "client_id": "string",
  "account_balance": "string",
  "investment_profile": "string",
  "flow": "string",
  "deadline": "integer",
  "new_response": "boolean",
  "agroup_fixed_incomes": "number",
  "investment_balances": {
    "name": "string",
    "deadline": "integer",
    "financial_goal": "number",
    "initial_capital": "number",
    "investment_period": "number",
    "balance": "number",
    "products": [
      {
        "id": "string",
        "balance": "number",
        "investment_date": "date (DD/MM/YYYY)",
        "name": "string",
        "fixed_incomes": "boolean",
        "type": "string",
        "indexer": "string",
        "fee": "number",
        "daily_liquidity": "boolean",
        "deadline": "integer"
      }
    ]
  }
}
201 Created

Carteira sugerida e mais informações

Response Content-Types: application/json
Response Example (201 Created)
{
  "capital_invest": "number",
  "deadline": "integer",
  "financial_goal": "number",
  "initial_capital": "number",
  "investment_period": "number",
  "message": "string",
  "success": "boolean",
  "indexers": [
    {
      "name": "string",
      "rate": "string"
    }
  ],
  "investment_goal": {
    "id": "string",
    "name": "string"
  },
  "recurring_product": [
    {
      "allocation": "number",
      "deadline_fixed_income": "string",
      "disclaimer": "string",
      "fee_fixed_income": "string",
      "financial_balance": "number",
      "id": "string",
      "minimum_value": "number",
      "name": "string",
      "percentage": "string",
      "risk": "string",
      "type": "string"
    }
  ],
  "projections": [
    {
      "benchmarks": "object",
      "benchmarks_class_product": "object",
      "products": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "capital_invest": "number",
      "deadline_achive_goal": "integer",
      "gross_value": "number",
      "name": "string",
      "net_value": "number",
      "value_achive_goal": "number",
      "projections": "array"
    }
  ]
}

Resgate Inteligente

Endpoint responsável pelo resgate inteligente em um ou mais produtos de um cliente. Ele é responsável por indentificar o melhor cenário para retirada do recurso nas carteiras do cliente.

Resgate Inteligente

POST /v3/rescue

Request body

x-api-key: string
in header

api key

Request Content-Types: application/json
Request Example
{
  "client_id": "string",
  "investment_profile": "string",
  "rescue_value": "number",
  "rescue_automatic": "boolean",
  "investments": [
    {
      "id": "string",
      "name": "string",
      "deadline": "integer",
      "deduce_income_tax": "string",
      "deduce_quota_eating": "string",
      "financial_goal": "number",
      "full_percentage_cdi": "string",
      "initial_capital": "number",
      "investment_period": "number",
      "max_deadline": "integer",
      "lock_deadline": "string",
      "closest_due_date": "string",
      "products": [
        {
          "id": "string",
          "initial_capital": "number",
          "investment_date": "date (DD/MM/YYYY)",
          "name": "string",
          "fixed_incomes": "boolean",
          "type": "string",
          "indexer": "string",
          "fee": "number",
          "daily_liquidity": "boolean",
          "deadline": "integer",
          "minimum_value": "number",
          "add": [
            {
              "value": "number",
              "date": "number"
            }
          ],
          "rescue": [
            {
              "value": "number",
              "date": "number"
            }
          ]
        }
      ]
    }
  ],
  "products": [
    {
      "id": "string",
      "balance": "number",
      "investment_date": "date (DD/MM/YYYY)",
      "name": "string",
      "fixed_incomes": "boolean",
      "type": "string",
      "indexer": "string",
      "fee": "number",
      "daily_liquidity": "boolean",
      "deadline": "integer",
      "minimum_value": "number"
    }
  ]
}
201 Created

Carteira sugerida e mais informações

400 Bad Request

Invalid type in request data

Response Content-Types: application/json
Response Example (201 Created)
{
  "deadline": "integer",
  "financial_assets": [
    {
      "added": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "assets": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "invested": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "rescued": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ]
    }
  ],
  "id": "string",
  "initial_capital": "number",
  "name": "string"
}

Produto Fundos de Investimento

Endpoints responsáveis pelo download planilha modelo e atualização do produto Fundos de Investimento.

Download Exemplo

GET /parametrization/client-products/investment-funds

Download planilha modelo para cadastro Fundos de Investimento

200 OK

Planilha modelo

Response Content-Types: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Cadastrar

POST /parametrization/client-products/investment-funds

Cadastrar Fundos de Investimento

Authorization: string Bearer {token}
in header

Token JWT. Para a obtenção do token por favor consulte nossa documentação: https://documenter.getpostman.com/view/2843755/RzfarrW7

x-api-key: string
in header

api key

arquivo: file
in formData

Planilha com as informações do produto

is_pension: boolean
in formData

Flag que indica se api_key é de previdência privada.

200 OK
Response Content-Types: application/json
Response Headers (200 OK)

Cotas

POST /v3/quota

Cadastrar cota diariamente Fundos de Investimento

Request body

Authorization: string Bearer {token}
in header

Token JWT. Para a obtenção do token por favor consulte nossa documentação: https://documenter.getpostman.com/view/2843755/RzfarrW7

x-api-key: string
in header

api key

Request Content-Types: application/json
Request Example
{
  "product_id": "string",
  "cnpj": "string",
  "quota": "number",
  "quota_date": "date (DD/MM/YYYY)"
}
201 Created
Response Content-Types: application/json
Response Headers (201 Created)

Produto Título Renda Fixa

Endpoints responsáveis pelo download planilha modelo e atualização do produto Título de Renda Fixa.

Download Exemplo

GET /parametrization/client-products/fixed-incomes

Download planilha modelo para cadastro Título Renda Fixa

200 OK

Planilha modelo

Response Content-Types: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Cadastrar

POST /parametrization/client-products/fixed-incomes

Cadastrar Título Renda Fixa

Authorization: string Bearer {token}
in header

Token JWT. Para a obtenção do token por favor consulte nossa documentação: https://documenter.getpostman.com/view/2843755/RzfarrW7

x-api-key: string
in header

api key

arquivo: file
in formData

Planilha com as informações do produto

is_pension: boolean
in formData

Flag que indica se api_key é de previdência privada.

200 OK
Response Content-Types: application/json
Response Headers (200 OK)

Produto COE

Endpoints responsáveis pelo download planilha modelo e atualização do produto COE.

Download Exemplo

GET /parametrization/client-products/coe

Download planilha modelo para cadastro COE

200 OK

Planilha modelo

Response Content-Types: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Cadastrar

POST /parametrization/client-products/coe

Cadastrar COE

Authorization: string Bearer {token}
in header

Token JWT. Para a obtenção do token por favor consulte nossa documentação: https://documenter.getpostman.com/view/2843755/RzfarrW7

x-api-key: string
in header

api key

arquivo: file
in formData

Planilha com as informações do produto

is_pension: boolean
in formData

Flag que indica se api_key é de previdência privada.

200 OK
Response Content-Types: application/json
Response Headers (200 OK)

Produto Tesouro Direto

Endpoints responsáveis pelo download planilha modelo e atualização do produto Tesouro Direto.

Download Exemplo

GET /parametrization/client-products/treasury-bonds

Download planilha modelo para cadastro Tesouro Direto

200 OK

Planilha modelo

Response Content-Types: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Cadastrar

POST /parametrization/client-products/treasury-bonds

Cadastrar Tesouro Direto

Authorization: string Bearer {token}
in header

Token JWT. Para a obtenção do token por favor consulte nossa documentação: https://documenter.getpostman.com/view/2843755/RzfarrW7

x-api-key: string
in header

api key

arquivo: file
in formData

Planilha com as informações do produto

is_pension: boolean
in formData

Flag que indica se api_key é de previdência privada.

200 OK
Response Content-Types: application/json
Response Headers (200 OK)

Schema Definitions

SimulationRequest: object

agroup_fixed_incomes: string

Agrupar Produtos Renda Fixa em um único produto? (S/N)

agroup_products: string N

Agrupar Produtos de acordo com tipo e classe? (S/N)

deadline: integer

Prazo

deduce_income_tax: string

Deduzir Imposto de Renda? (S/N)

financial_goal: number 0

Meta Financeira

full_percentage_cdi: string

Produtos Renda Fixa e COE com 100% CDI? (S/N)

initial_capital: number

Capital Inicial

investment_period: number

Investimento Mensal

investment_profile: string

Perfil de Investidor

save_investment: string

Gerar somente simulação sem gráfico de projeções? (S/N)

max_deadline: integer

Prazo máximo que a API utilizará para sugerir carteiras

name: string

Nome para a carteira

only_projections: string

Somente a simulação sem meta financeira? (S/N)

lock_deadline: string

Travar títulos de Renda Fixa de acordo com o prazo informado pelo cliente? (S/N)

closest_due_date: string

Travar títulos de Renda Fixa de acordo com o prazo de vencimento mais próximo? (S/N)

Example
{
  "agroup_fixed_incomes": "string",
  "agroup_products": "string",
  "deadline": "integer",
  "deduce_income_tax": "string",
  "financial_goal": "number",
  "full_percentage_cdi": "string",
  "initial_capital": "number",
  "investment_period": "number",
  "investment_profile": "string",
  "save_investment": "string",
  "max_deadline": "integer",
  "name": "string",
  "only_projections": "string",
  "lock_deadline": "string",
  "closest_due_date": "string"
}

SimulationResponse: object

capital_invest: number

Capital Investido

deadline: integer

Para conquistar a meta financeira ou o prazo informado pelo cliente no senário de simulação sem meta financeira

financial_goal: number

Meta financeira definida pelo cliente

initial_capital: number

Capital inicial da carteira

investment_period: number

Capital mensal da carteira

message: string

Mensagem de retorno. Cada cenário de simulação possui mensagens específicas. Você pode parametrizar essas mensagens do modo que achar mais conveniente.

success: boolean

Flag que indica o sucesso ou não da simulação. Vale ressaltar que o valor 'false' não significa erro da API, mas sim a não geração da carteira por algum motivo.

indexers: Indexers

Array com os valores dos índices econômicos utilizados pela API

Indexers
investment_goal: InvestmentGoal

Informações básicas da carteira do cliente

recurring_product: RecurringProducts

Array com os produtos da carteira para investimento mensal

RecurringProducts
projections: Projections

Array com as projeções do investimento e benchmarks (Poupança, CDI, IBOVESPA)

Projections
Example
{
  "capital_invest": "number",
  "deadline": "integer",
  "financial_goal": "number",
  "initial_capital": "number",
  "investment_period": "number",
  "message": "string",
  "success": "boolean",
  "indexers": [
    {
      "name": "string",
      "rate": "string"
    }
  ],
  "investment_goal": {
    "id": "string",
    "name": "string"
  },
  "recurring_product": [
    {
      "allocation": "number",
      "deadline_fixed_income": "string",
      "disclaimer": "string",
      "fee_fixed_income": "string",
      "financial_balance": "number",
      "id": "string",
      "minimum_value": "number",
      "name": "string",
      "percentage": "string",
      "risk": "string",
      "type": "string"
    }
  ],
  "projections": [
    {
      "benchmarks": "object",
      "benchmarks_class_product": "object",
      "products": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "capital_invest": "number",
      "deadline_achive_goal": "integer",
      "gross_value": "number",
      "name": "string",
      "net_value": "number",
      "value_achive_goal": "number",
      "projections": "array"
    }
  ]
}

Indexers: object

name: string
rate: string
Example
{
  "name": "string",
  "rate": "string"
}

InvestmentGoal: object

id: string
name: string
Example
{
  "id": "string",
  "name": "string"
}

RecurringProducts: object

allocation: number

Porcentagem da alocação na carteira

deadline_fixed_income: string

Prazo dos títulos de renda fixa

disclaimer: string

Disclaimer informativo

fee_fixed_income: string

Taxa dos títulos renda fixa

financial_balance: number

Valor da aplicação na carteira

id: string

ID

minimum_value: number

Valor mínimo de aplicação

name: string

Nome

percentage: string

Porcentagem da alocação na carteira (formatado)

risk: string

Risco

type: string

Tipo (Classe)

Example
{
  "allocation": "number",
  "deadline_fixed_income": "string",
  "disclaimer": "string",
  "fee_fixed_income": "string",
  "financial_balance": "number",
  "id": "string",
  "minimum_value": "number",
  "name": "string",
  "percentage": "string",
  "risk": "string",
  "type": "string"
}

Projections: object

benchmarks: object

Benchmark carteira em relação CDI e IBOVESPA

benchmarks_class_product: object

Benchmarks das classes de produtos da carteira em relação CDI e IBOVESPA

products: Products

Produtos da carteira

Products
capital_invest: number

Capital Investido

deadline_achive_goal: integer

Prazo que o cliente conseguirá atingir a meta financeira

gross_value: number

Valor Bruto

name: string

Nome da projeção (Investimento, Poupança, CDI, Ibovespa)

net_value: number

Valor Líquido

value_achive_goal: number

Valor da carteira no prazo que irá atingir a meta financeira

projections: array

Array com as projeções mensais. Ideal para a plotagem do gráfico

Example
{
  "benchmarks": "object",
  "benchmarks_class_product": "object",
  "products": [
    {
      "allocation": "number",
      "deadline_fixed_income": "string",
      "disclaimer": "string",
      "fee_fixed_income": "string",
      "financial_balance": "number",
      "id": "string",
      "minimum_value": "number",
      "name": "string",
      "percentage": "string",
      "risk": "string",
      "type": "string",
      "benchmarks": "object",
      "new_benchmarks": "object"
    }
  ],
  "capital_invest": "number",
  "deadline_achive_goal": "integer",
  "gross_value": "number",
  "name": "string",
  "net_value": "number",
  "value_achive_goal": "number",
  "projections": "array"
}

Products: object

allocation: number

Porcentagem da alocação na carteira

deadline_fixed_income: string

Prazo dos títulos de renda fixa

disclaimer: string

Disclaimer informativo

fee_fixed_income: string

Taxa dos títulos renda fixa

financial_balance: number

Valor da aplicação na carteira

id: string

ID

minimum_value: number

Valor mínimo de aplicação

name: string

Nome

percentage: string

Porcentagem da alocação na carteira (formatado)

risk: string

Risco

type: string

Tipo (Classe)

benchmarks: object

Benchmark produto em relação CDI e IBOVESPA (somente produtos do array 'assets' e 'invested')

new_benchmarks: object

Benchmark produto em relação CDI e IBOVESPA após aporte/resgate (somente produtos do array 'assets')

Example
{
  "allocation": "number",
  "deadline_fixed_income": "string",
  "disclaimer": "string",
  "fee_fixed_income": "string",
  "financial_balance": "number",
  "id": "string",
  "minimum_value": "number",
  "name": "string",
  "percentage": "string",
  "risk": "string",
  "type": "string",
  "benchmarks": "object",
  "new_benchmarks": "object"
}

V3Request: object

client_id: string

ID do Cliente

investment_profile: string

Perfil de Investidor

new_response: boolean

Deseja retornar a resposta no formato do novo modelo?

new_financial_resource: number

Valor do Aporte Adicional

benchmarks: string[]

Lista de benchmarks desejados

string
investments: InvestmentsV3Add
InvestmentsV3Add
products: AllProductsAdd

Informações dos produtos

AllProductsAdd
Example
{
  "client_id": "string",
  "investment_profile": "string",
  "new_response": "boolean",
  "new_financial_resource": "number",
  "benchmarks": [
    "string"
  ],
  "investments": [
    {
      "id": "string",
      "name": "string",
      "deadline": "integer",
      "deduce_income_tax": "string",
      "financial_goal": "number",
      "full_percentage_cdi": "string",
      "initial_capital": "number",
      "investment_period": "number",
      "max_deadline": "integer",
      "lock_deadline": "string",
      "closest_due_date": "string",
      "products": [
        {
          "id": "string",
          "initial_capital": "number",
          "investment_date": "date (DD/MM/YYYY)",
          "name": "string",
          "fixed_incomes": "boolean",
          "type": "string",
          "indexer": "string",
          "fee": "number",
          "daily_liquidity": "boolean",
          "deadline": "integer",
          "minimum_value": "number"
        }
      ]
    }
  ],
  "products": [
    {
      "id": "string",
      "balance": "number",
      "investment_date": "date (DD/MM/YYYY)",
      "name": "string",
      "fixed_incomes": "boolean",
      "type": "string",
      "indexer": "string",
      "fee": "number",
      "daily_liquidity": "boolean",
      "deadline": "integer",
      "minimum_value": "number"
    }
  ]
}

InvestmentsV3Add: object

id: string

ID do objetivo

name: string

Nome do objetivo

deadline: integer

Prazo

deduce_income_tax: string

Deduzir Imposto de Renda? (S/N)

financial_goal: number 0

Meta Financeira

full_percentage_cdi: string

Produtos Renda Fixa e COE com 100% CDI? (S/N)

initial_capital: number

Capital Inicial

investment_period: number

Investimento Mensal

max_deadline: integer

Prazo máximo que a API utilizará para sugerir carteiras

lock_deadline: string

Travar títulos de Renda Fixa de acordo com o prazo informado pelo cliente? (S/N)

closest_due_date: string

Travar títulos de Renda Fixa de acordo com o prazo de vencimento mais próximo? (S/N)

products: ProductsV3Add

Informações dos produtos

ProductsV3Add
Example
{
  "id": "string",
  "name": "string",
  "deadline": "integer",
  "deduce_income_tax": "string",
  "financial_goal": "number",
  "full_percentage_cdi": "string",
  "initial_capital": "number",
  "investment_period": "number",
  "max_deadline": "integer",
  "lock_deadline": "string",
  "closest_due_date": "string",
  "products": [
    {
      "id": "string",
      "initial_capital": "number",
      "investment_date": "date (DD/MM/YYYY)",
      "name": "string",
      "fixed_incomes": "boolean",
      "type": "string",
      "indexer": "string",
      "fee": "number",
      "daily_liquidity": "boolean",
      "deadline": "integer",
      "minimum_value": "number"
    }
  ]
}

ProductsV3Add: object

id: string

ID

initial_capital: number

Capital investido no produto

investment_date: date (DD/MM/YYYY)

Data da Aplicação

name: string

Nome

fixed_incomes: boolean

É Título de Renda Fixa?

type: string

Tipo Título de Renda Fixa (PRE / POS)

indexer: string

Indexador Título de Renda Fixa

fee: number

Taxa Título de Renda Fixa

daily_liquidity: boolean

É liquidez diária?

deadline: integer

Prazo Título de Renda Fixa

minimum_value: number

Valor mínimo de aplicação Título de Renda Fixa

Example
{
  "id": "string",
  "initial_capital": "number",
  "investment_date": "date (DD/MM/YYYY)",
  "name": "string",
  "fixed_incomes": "boolean",
  "type": "string",
  "indexer": "string",
  "fee": "number",
  "daily_liquidity": "boolean",
  "deadline": "integer",
  "minimum_value": "number"
}

AllProductsAdd: object

id: string

ID

balance: number

Saldo

investment_date: date (DD/MM/YYYY)

Data da Aplicação

name: string

Nome

fixed_incomes: boolean

É Título de Renda Fixa?

type: string

Tipo Título de Renda Fixa (PRE / POS)

indexer: string

Indexador Título de Renda Fixa

fee: number

Taxa Título de Renda Fixa

daily_liquidity: boolean

É liquidez diária?

deadline: integer

Prazo Título de Renda Fixa

minimum_value: number

Valor mínimo de aplicação Título de Renda Fixa

Example
{
  "id": "string",
  "balance": "number",
  "investment_date": "date (DD/MM/YYYY)",
  "name": "string",
  "fixed_incomes": "boolean",
  "type": "string",
  "indexer": "string",
  "fee": "number",
  "daily_liquidity": "boolean",
  "deadline": "integer",
  "minimum_value": "number"
}

V3Response: object

capital_invest: number

Capital Investido

deadline: integer

Para conquistar a meta financeira ou o prazo informado pelo cliente no senário de simulação sem meta financeira

financial_goal: number

Meta financeira definida pelo cliente

indexers: Indexers

Array com os valores dos índices econômicos utilizados pela API

Indexers
initial_capital: number

Capital inicial da carteira

investment_period: number

Capital mensal da carteira

message: string

Mensagem de retorno. Cada cenário de simulação possui mensagens específicas. Você pode parametrizar essas mensagens do modo que achar mais conveniente.

success: boolean

Flag que indica o sucesso ou não da simulação. Vale ressaltar que o valor 'false' não significa erro da API, mas sim a não geração da carteira por algum motivo.

best_investment: string

Nome do objetivo para a realização do aporte

recurring_product: RecurringProducts

Array com os produtos da carteira para investimento mensal

RecurringProducts
projections: Projections

Array com as projeções do investimento e benchmarks (Poupança, CDI, IBOVESPA)

Projections
benchmarks: array

Benchmark da carteira em relação a CDI, IBOVESPA

benchmarks_class_product: array

Benchmark de cada classe de produto da carteira em relação a CDI, IBOVESPA

new_benchmarks: array

Benchmark da carteira após o aporte em relação a CDI, IBOVESPA

new_benchmarks_class_product: array

Benchmark de cada classe de produto da carteira após o aporte em relação a CDI, IBOVESPA

Example
{
  "capital_invest": "number",
  "deadline": "integer",
  "financial_goal": "number",
  "indexers": [
    {
      "name": "string",
      "rate": "string"
    }
  ],
  "initial_capital": "number",
  "investment_period": "number",
  "message": "string",
  "success": "boolean",
  "best_investment": "string",
  "recurring_product": [
    {
      "allocation": "number",
      "deadline_fixed_income": "string",
      "disclaimer": "string",
      "fee_fixed_income": "string",
      "financial_balance": "number",
      "id": "string",
      "minimum_value": "number",
      "name": "string",
      "percentage": "string",
      "risk": "string",
      "type": "string"
    }
  ],
  "projections": [
    {
      "benchmarks": "object",
      "benchmarks_class_product": "object",
      "products": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "capital_invest": "number",
      "deadline_achive_goal": "integer",
      "gross_value": "number",
      "name": "string",
      "net_value": "number",
      "value_achive_goal": "number",
      "projections": "array"
    }
  ],
  "benchmarks": "array",
  "benchmarks_class_product": "array",
  "new_benchmarks": "array",
  "new_benchmarks_class_product": "array"
}

V2Request: object

client_id: string

ID do Cliente

investment_profile: string

Perfil de Investidor

new_response: boolean

Deseja retornar a resposta no formato do novo modelo?

new_financial_resource: number

Valor do Aporte Adicional

benchmarks: string[]

Lista de benchmarks desejados

string
agroup_fixed_incomes: number

Saldo em conta corrente

account_balance: string

Agrupar Produtos Renda Fixa em um único produto? (S/N)

investments: InvestmentsV2Add
products: AllProductsAdd

Informações dos produtos

AllProductsAdd
deduce_income_tax: string

Deduzir Imposto de Renda? (S/N)

max_deadline: integer

Prazo máximo que a API utilizará para sugerir carteiras

Example
{
  "client_id": "string",
  "investment_profile": "string",
  "new_response": "boolean",
  "new_financial_resource": "number",
  "benchmarks": [
    "string"
  ],
  "agroup_fixed_incomes": "number",
  "account_balance": "string",
  "investments": {
    "name": "string",
    "deadline": "integer",
    "financial_goal": "number",
    "initial_capital": "number",
    "investment_period": "number",
    "balance": "number"
  },
  "products": [
    {
      "id": "string",
      "balance": "number",
      "investment_date": "date (DD/MM/YYYY)",
      "name": "string",
      "fixed_incomes": "boolean",
      "type": "string",
      "indexer": "string",
      "fee": "number",
      "daily_liquidity": "boolean",
      "deadline": "integer",
      "minimum_value": "number"
    }
  ],
  "deduce_income_tax": "string",
  "max_deadline": "integer"
}

InvestmentsV2Add: object

name: string

Nome do objetivo

deadline: integer

Prazo

financial_goal: number 0

Meta Financeira

initial_capital: number

Capital Inicial

investment_period: number

Investimento Mensal

balance: number

Saldo atual da carteira

Example
{
  "name": "string",
  "deadline": "integer",
  "financial_goal": "number",
  "initial_capital": "number",
  "investment_period": "number",
  "balance": "number"
}

V2Response: object

capital_invest: number

Capital Investido

deadline: integer

Para conquistar a meta financeira ou o prazo informado pelo cliente no senário de simulação sem meta financeira

financial_goal: number

Meta financeira definida pelo cliente

indexers: Indexers

Array com os valores dos índices econômicos utilizados pela API

Indexers
initial_capital: number

Capital inicial da carteira

investment_period: number

Capital mensal da carteira

message: string

Mensagem de retorno. Cada cenário de simulação possui mensagens específicas. Você pode parametrizar essas mensagens do modo que achar mais conveniente.

success: boolean

Flag que indica o sucesso ou não da simulação. Vale ressaltar que o valor 'false' não significa erro da API, mas sim a não geração da carteira por algum motivo.

investment_goal: InvestmentGoal

Informações básicas da carteira do cliente

recurring_product: RecurringProducts

Array com os produtos da carteira para investimento mensal

RecurringProducts
projections: ProjectionsV2

Array com as projeções do investimento e benchmarks (Poupança, CDI, IBOVESPA)

ProjectionsV2
Example
{
  "capital_invest": "number",
  "deadline": "integer",
  "financial_goal": "number",
  "indexers": [
    {
      "name": "string",
      "rate": "string"
    }
  ],
  "initial_capital": "number",
  "investment_period": "number",
  "message": "string",
  "success": "boolean",
  "investment_goal": "object",
  "recurring_product": [
    {
      "allocation": "number",
      "deadline_fixed_income": "string",
      "disclaimer": "string",
      "fee_fixed_income": "string",
      "financial_balance": "number",
      "id": "string",
      "minimum_value": "number",
      "name": "string",
      "percentage": "string",
      "risk": "string",
      "type": "string"
    }
  ],
  "projections": [
    {
      "benchmarks": "object",
      "benchmarks_class_product": "object",
      "products": [
        {
          "added": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ],
          "assets": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ],
          "invested": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ],
          "rescued": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ]
        }
      ]
    }
  ]
}

ProjectionsV2: object

benchmarks: object

Benchmark carteira em relação CDI e IBOVESPA

benchmarks_class_product: object

Benchmarks das classes de produtos da carteira em relação CDI e IBOVESPA

products: ProductsV2

Produtos da carteira

ProductsV2
capital_invest: number

Capital Investido

deadline_achive_goal: integer

Prazo que o cliente conseguirá atingir a meta financeira

gross_value: number

Valor Bruto

name: string

Nome da projeção (Investimento, Poupança, CDI, Ibovespa)

net_value: number

Valor Líquido

value_achive_goal: number

Valor da carteira no prazo que irá atingir a meta financeira

projections: array

Array com as projeções mensais. Ideal para a plotagem do gráfico

new_benchmarks: array

Benchmark da carteira após o aporte em relação a CDI, IBOVESPA

new_benchmarks_class_product: array

Benchmark de cada classe de produto da carteira após o aporte em relação a CDI, IBOVESPA

Example
{
  "benchmarks": "object",
  "benchmarks_class_product": "object",
  "products": [
    {
      "added": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "assets": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "invested": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "rescued": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ]
    }
  ],
  "capital_invest": "number",
  "deadline_achive_goal": "integer",
  "gross_value": "number",
  "name": "string",
  "net_value": "number",
  "value_achive_goal": "number",
  "projections": "array",
  "new_benchmarks": "array",
  "new_benchmarks_class_product": "array"
}

ProductsV2: object

added: Products

Array com os produtos para aporte

Products
assets: Products

Array com os produtos finais da carteira

Products
invested: Products

Array com os produtos iniciais da carteira

Products
rescued: Products

Array com os produtos para resgate

Products
Example
{
  "added": [
    {
      "allocation": "number",
      "deadline_fixed_income": "string",
      "disclaimer": "string",
      "fee_fixed_income": "string",
      "financial_balance": "number",
      "id": "string",
      "minimum_value": "number",
      "name": "string",
      "percentage": "string",
      "risk": "string",
      "type": "string",
      "benchmarks": "object",
      "new_benchmarks": "object"
    }
  ],
  "assets": [
    {
      "allocation": "number",
      "deadline_fixed_income": "string",
      "disclaimer": "string",
      "fee_fixed_income": "string",
      "financial_balance": "number",
      "id": "string",
      "minimum_value": "number",
      "name": "string",
      "percentage": "string",
      "risk": "string",
      "type": "string",
      "benchmarks": "object",
      "new_benchmarks": "object"
    }
  ],
  "invested": [
    {
      "allocation": "number",
      "deadline_fixed_income": "string",
      "disclaimer": "string",
      "fee_fixed_income": "string",
      "financial_balance": "number",
      "id": "string",
      "minimum_value": "number",
      "name": "string",
      "percentage": "string",
      "risk": "string",
      "type": "string",
      "benchmarks": "object",
      "new_benchmarks": "object"
    }
  ],
  "rescued": [
    {
      "allocation": "number",
      "deadline_fixed_income": "string",
      "disclaimer": "string",
      "fee_fixed_income": "string",
      "financial_balance": "number",
      "id": "string",
      "minimum_value": "number",
      "name": "string",
      "percentage": "string",
      "risk": "string",
      "type": "string",
      "benchmarks": "object",
      "new_benchmarks": "object"
    }
  ]
}

SaldoParadoContaRequest: object

client_id: string

ID do Cliente

account_balance: string

Agrupar Produtos Renda Fixa em um único produto? (S/N)

investment_profile: string

Perfil de Investidor

flow: string

Flag do Fluxo

deadline: integer

Valor do Aporte Adicional

new_response: boolean

Deseja retornar a resposta no formato do novo modelo?

agroup_fixed_incomes: number

Saldo em conta corrente

investment_balances: InvestmentsSaldoParadoConta
Example
{
  "client_id": "string",
  "account_balance": "string",
  "investment_profile": "string",
  "flow": "string",
  "deadline": "integer",
  "new_response": "boolean",
  "agroup_fixed_incomes": "number",
  "investment_balances": {
    "name": "string",
    "deadline": "integer",
    "financial_goal": "number",
    "initial_capital": "number",
    "investment_period": "number",
    "balance": "number",
    "products": [
      {
        "id": "string",
        "balance": "number",
        "investment_date": "date (DD/MM/YYYY)",
        "name": "string",
        "fixed_incomes": "boolean",
        "type": "string",
        "indexer": "string",
        "fee": "number",
        "daily_liquidity": "boolean",
        "deadline": "integer"
      }
    ]
  }
}

InvestmentsSaldoParadoConta: object

name: string

Nome do objetivo

deadline: integer

Prazo

financial_goal: number 0

Meta Financeira

initial_capital: number

Capital Inicial

investment_period: number

Investimento Mensal

balance: number

Saldo atual da carteira

products: ProductsSaldoParadoConta

Produtos da carteira

ProductsSaldoParadoConta
Example
{
  "name": "string",
  "deadline": "integer",
  "financial_goal": "number",
  "initial_capital": "number",
  "investment_period": "number",
  "balance": "number",
  "products": [
    {
      "id": "string",
      "balance": "number",
      "investment_date": "date (DD/MM/YYYY)",
      "name": "string",
      "fixed_incomes": "boolean",
      "type": "string",
      "indexer": "string",
      "fee": "number",
      "daily_liquidity": "boolean",
      "deadline": "integer"
    }
  ]
}

ProductsSaldoParadoConta: object

id: string

ID

balance: number

Saldo

investment_date: date (DD/MM/YYYY)

Data da Aplicação

name: string

Nome

fixed_incomes: boolean

É Título de Renda Fixa?

type: string

Tipo Título de Renda Fixa (PRE / POS)

indexer: string

Indexador Título de Renda Fixa

fee: number

Taxa Título de Renda Fixa

daily_liquidity: boolean

É liquidez diária?

deadline: integer

Prazo Título de Renda Fixa

Example
{
  "id": "string",
  "balance": "number",
  "investment_date": "date (DD/MM/YYYY)",
  "name": "string",
  "fixed_incomes": "boolean",
  "type": "string",
  "indexer": "string",
  "fee": "number",
  "daily_liquidity": "boolean",
  "deadline": "integer"
}

TrackBalanceSimulatorRequest: object

client_id: string

ID do Cliente

account_balance: string

Agrupar Produtos Renda Fixa em um único produto? (S/N)

investment_profile: string

Perfil de Investidor

new_response: boolean

Deseja retornar a resposta no formato do novo modelo?

simulation: InvestmentsSimulator
products: ProductsSaldoParadoConta

Produtos da carteira

ProductsSaldoParadoConta
Example
{
  "client_id": "string",
  "account_balance": "string",
  "investment_profile": "string",
  "new_response": "boolean",
  "simulation": {
    "agroup_fixed_incomes": "string",
    "agroup_products": "string",
    "deadline": "integer",
    "deduce_income_tax": "string",
    "financial_goal": "number",
    "full_percentage_cdi": "string",
    "initial_capital": "number",
    "investment_period": "number",
    "investment_profile": "string",
    "save_investment": "string",
    "max_deadline": "integer",
    "name": "string",
    "only_projections": "string",
    "simulation_date": "date"
  },
  "products": [
    {
      "id": "string",
      "balance": "number",
      "investment_date": "date (DD/MM/YYYY)",
      "name": "string",
      "fixed_incomes": "boolean",
      "type": "string",
      "indexer": "string",
      "fee": "number",
      "daily_liquidity": "boolean",
      "deadline": "integer"
    }
  ]
}

InvestmentsSimulator: object

agroup_fixed_incomes: string

Agrupar Produtos Renda Fixa em um único produto? (S/N)

agroup_products: string N

Agrupar Produtos de acordo com tipo e classe? (S/N)

deadline: integer

Prazo

deduce_income_tax: string

Deduzir Imposto de Renda? (S/N)

financial_goal: number 0

Meta Financeira

full_percentage_cdi: string

Produtos Renda Fixa e COE com 100% CDI? (S/N)

initial_capital: number

Capital Inicial

investment_period: number

Investimento Mensal

investment_profile: string

Perfil de Investidor

save_investment: string

Gerar somente simulação sem gráfico de projeções? (S/N)

max_deadline: integer

Prazo máximo que a API utilizará para sugerir carteiras

name: string

Nome para a carteira

only_projections: string

Somente a simulação sem meta financeira? (S/N)

simulation_date: date

Data da simulação não concretizada pelo cliente

Example
{
  "agroup_fixed_incomes": "string",
  "agroup_products": "string",
  "deadline": "integer",
  "deduce_income_tax": "string",
  "financial_goal": "number",
  "full_percentage_cdi": "string",
  "initial_capital": "number",
  "investment_period": "number",
  "investment_profile": "string",
  "save_investment": "string",
  "max_deadline": "integer",
  "name": "string",
  "only_projections": "string",
  "simulation_date": "date"
}

PensionRequest: object

name: string

Nome para a carteira

current_age: integer

Idade Atual

retirement_age: integer

Idade de aposentadoria

life_expectancy: integer 100

Expectativa de Vida

monthly_retirement_income: number

Renda mensal durante a aposentadoria

initial_capital: number

Capital Inicial

investment_profile: string

Perfil de Investidor

investment_period: number

Investimento Mensal

max_deadline: integer

Prazo máximo que a API utilizará para sugerir carteiras

agroup_fixed_incomes: string

Agrupar Produtos Renda Fixa em um único produto? (S/N)

agroup_products: string N

Agrupar Produtos de acordo com tipo e classe? (S/N)

deduce_income_tax: string

Deduzir Imposto de Renda? (S/N)

full_percentage_cdi: string

Produtos Renda Fixa e COE com 100% CDI? (S/N)

pension_plan: string

Plano de Previdência (PGBL / VGBL)

pension_table: string

Tabela de Previdência (progressiva / agressiva)

Example
{
  "name": "string",
  "current_age": "integer",
  "retirement_age": "integer",
  "life_expectancy": "integer",
  "monthly_retirement_income": "number",
  "initial_capital": "number",
  "investment_profile": "string",
  "investment_period": "number",
  "max_deadline": "integer",
  "agroup_fixed_incomes": "string",
  "agroup_products": "string",
  "deduce_income_tax": "string",
  "full_percentage_cdi": "string",
  "pension_plan": "string",
  "pension_table": "string"
}

PensionResponse: object

capital_invest: number

Capital Investido

deadline: integer

Para conquistar a meta financeira ou o prazo informado pelo cliente no senário de simulação sem meta financeira

financial_goal: number

Meta financeira definida pelo cliente

initial_capital: number

Capital inicial da carteira

investment_period: number

Capital mensal da carteira

message: string

Mensagem de retorno. Cada cenário de simulação possui mensagens específicas. Você pode parametrizar essas mensagens do modo que achar mais conveniente.

success: boolean

Flag que indica o sucesso ou não da simulação. Vale ressaltar que o valor 'false' não significa erro da API, mas sim a não geração da carteira por algum motivo.

indexers: Indexers

Array com os valores dos índices econômicos utilizados pela API

Indexers
investment_goal: InvestmentGoal

Informações básicas da carteira do cliente

pension_indication: object

Sugestão de Plano e Tabela de Aposentadoria

recurring_product: RecurringProducts

Array com os produtos da carteira para investimento mensal

RecurringProducts
projections: PensionProjections

Array com as projeções do investimento e benchmarks (Poupança, CDI, IBOVESPA)

PensionProjections
Example
{
  "capital_invest": "number",
  "deadline": "integer",
  "financial_goal": "number",
  "initial_capital": "number",
  "investment_period": "number",
  "message": "string",
  "success": "boolean",
  "indexers": [
    {
      "name": "string",
      "rate": "string"
    }
  ],
  "investment_goal": "object",
  "pension_indication": "object",
  "recurring_product": [
    {
      "allocation": "number",
      "deadline_fixed_income": "string",
      "disclaimer": "string",
      "fee_fixed_income": "string",
      "financial_balance": "number",
      "id": "string",
      "minimum_value": "number",
      "name": "string",
      "percentage": "string",
      "risk": "string",
      "type": "string"
    }
  ],
  "projections": [
    {
      "deadline_achive_goal_formatted": "object",
      "products": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "capital_invest": "number",
      "deadline_achive_goal": "integer",
      "gross_value": "number",
      "name": "string",
      "net_value": "number",
      "value_achive_goal": "number",
      "projections": "array"
    }
  ]
}

PensionProjections: object

deadline_achive_goal_formatted: object

Tempo restante para aposentadoria com anos, meses, dias, horas, minutos e segundos

products: Products

Produtos da carteira

Products
capital_invest: number

Capital Investido

deadline_achive_goal: integer

Prazo que o cliente conseguirá atingir a meta financeira

gross_value: number

Valor Bruto

name: string

Nome da projeção (Investimento, Poupança, CDI, Ibovespa)

net_value: number

Valor Líquido

value_achive_goal: number

Valor da carteira no prazo que irá atingir a meta financeira

projections: array

Array com as projeções mensais. Ideal para a plotagem do gráfico

Example
{
  "deadline_achive_goal_formatted": "object",
  "products": [
    {
      "allocation": "number",
      "deadline_fixed_income": "string",
      "disclaimer": "string",
      "fee_fixed_income": "string",
      "financial_balance": "number",
      "id": "string",
      "minimum_value": "number",
      "name": "string",
      "percentage": "string",
      "risk": "string",
      "type": "string",
      "benchmarks": "object",
      "new_benchmarks": "object"
    }
  ],
  "capital_invest": "number",
  "deadline_achive_goal": "integer",
  "gross_value": "number",
  "name": "string",
  "net_value": "number",
  "value_achive_goal": "number",
  "projections": "array"
}

V3RentabilityRequest: object

client_id: string

ID do Cliente

investment_profile: string

Perfil de Investidor

group_by: string

Agrupar rentabilidade em MES / DIA

rescue_automatic: boolean

Resgate automático na data de vencimento dos títulos de renda fixa?

gross_up: boolean

Aplicar a técnica do gross up na carteira?

benchmarks: string[]

Lista de benchmarks desejados

string
investments: InvestmentsV3Rentability
InvestmentsV3Rentability
products: AllProductsAdd

Informações de todos os produtos de todas as carteiras

AllProductsAdd
start_date: date (DD/MM/YYYY)

Data inicial do período desejado

last_date: date (DD/MM/YYYY)

Data final do período desejado

Example
{
  "client_id": "string",
  "investment_profile": "string",
  "group_by": "string",
  "rescue_automatic": "boolean",
  "gross_up": "boolean",
  "benchmarks": [
    "string"
  ],
  "investments": [
    {
      "id": "string",
      "name": "string",
      "deadline": "integer",
      "deduce_income_tax": "string",
      "deduce_quota_eating": "string",
      "financial_goal": "number",
      "full_percentage_cdi": "string",
      "initial_capital": "number",
      "investment_period": "number",
      "max_deadline": "integer",
      "lock_deadline": "string",
      "closest_due_date": "string",
      "products": [
        {
          "id": "string",
          "initial_capital": "number",
          "investment_date": "date (DD/MM/YYYY)",
          "name": "string",
          "fixed_incomes": "boolean",
          "type": "string",
          "indexer": "string",
          "fee": "number",
          "daily_liquidity": "boolean",
          "deadline": "integer",
          "minimum_value": "number",
          "add": [
            {
              "value": "number",
              "date": "number"
            }
          ],
          "rescue": [
            {
              "value": "number",
              "date": "number"
            }
          ]
        }
      ]
    }
  ],
  "products": [
    {
      "id": "string",
      "balance": "number",
      "investment_date": "date (DD/MM/YYYY)",
      "name": "string",
      "fixed_incomes": "boolean",
      "type": "string",
      "indexer": "string",
      "fee": "number",
      "daily_liquidity": "boolean",
      "deadline": "integer",
      "minimum_value": "number"
    }
  ],
  "start_date": "date (DD/MM/YYYY)",
  "last_date": "date (DD/MM/YYYY)"
}

InvestmentsV3Rentability: object

id: string

ID do objetivo

name: string

Nome do objetivo

deadline: integer

Prazo

deduce_income_tax: string

Deduzir Imposto de Renda? (S/N)

deduce_quota_eating: string

Aplicar come cota fundos de investimento

financial_goal: number 0

Meta Financeira

full_percentage_cdi: string

Produtos Renda Fixa e COE com 100% CDI? (S/N)

initial_capital: number

Capital Inicial da carteira. Consiste no somatório dos capitais iniciais de todos os produtos da carteira.

investment_period: number

Investimento Mensal

max_deadline: integer

Prazo máximo que a API utilizará para sugerir carteiras

lock_deadline: string

Travar títulos de Renda Fixa de acordo com o prazo informado pelo cliente? (S/N)

closest_due_date: string

Travar títulos de Renda Fixa de acordo com o prazo de vencimento mais próximo? (S/N)

products: ProductsV3Rentability

Informações dos produtos

ProductsV3Rentability
Example
{
  "id": "string",
  "name": "string",
  "deadline": "integer",
  "deduce_income_tax": "string",
  "deduce_quota_eating": "string",
  "financial_goal": "number",
  "full_percentage_cdi": "string",
  "initial_capital": "number",
  "investment_period": "number",
  "max_deadline": "integer",
  "lock_deadline": "string",
  "closest_due_date": "string",
  "products": [
    {
      "id": "string",
      "initial_capital": "number",
      "investment_date": "date (DD/MM/YYYY)",
      "name": "string",
      "fixed_incomes": "boolean",
      "type": "string",
      "indexer": "string",
      "fee": "number",
      "daily_liquidity": "boolean",
      "deadline": "integer",
      "minimum_value": "number",
      "add": [
        {
          "value": "number",
          "date": "number"
        }
      ],
      "rescue": [
        {
          "value": "number",
          "date": "number"
        }
      ]
    }
  ]
}

ProductsV3Rentability: object

id: string

ID

initial_capital: number

Capital investido no produto

investment_date: date (DD/MM/YYYY)

Data da Aplicação

name: string

Nome

fixed_incomes: boolean

É Título de Renda Fixa?

type: string

Tipo Título de Renda Fixa (PRE / POS)

indexer: string

Indexador Título de Renda Fixa

fee: number

Taxa Título de Renda Fixa

daily_liquidity: boolean

É liquidez diária?

deadline: integer

Prazo Título de Renda Fixa

minimum_value: number

Valor mínimo de aplicação Título de Renda Fixa

add: ActionProducts

Array com todos os aportes realizados naquele produto

ActionProducts
rescue: ActionProducts

Array com todos os resgates realizados naquele produto

ActionProducts
Example
{
  "id": "string",
  "initial_capital": "number",
  "investment_date": "date (DD/MM/YYYY)",
  "name": "string",
  "fixed_incomes": "boolean",
  "type": "string",
  "indexer": "string",
  "fee": "number",
  "daily_liquidity": "boolean",
  "deadline": "integer",
  "minimum_value": "number",
  "add": [
    {
      "value": "number",
      "date": "number"
    }
  ],
  "rescue": [
    {
      "value": "number",
      "date": "number"
    }
  ]
}

ActionProducts: object

value: number

Valor da ação

date: number

Data da ação

Example
{
  "value": "number",
  "date": "number"
}

V3BalanceResponse: object

success: boolean

Flag que indica o sucesso ou não da simulação. Vale ressaltar que o valor 'false' não significa erro da API, mas sim a não geração da carteira por algum motivo.

message: string

Mensagem de retorno. Cada cenário de simulação possui mensagens específicas. Você pode parametrizar essas mensagens do modo que achar mais conveniente.

redistribuitions: Redistribuitions

Array com os produtos da carteira

Redistribuitions
Example
{
  "success": "boolean",
  "message": "string",
  "redistribuitions": [
    {
      "products": [
        {
          "added": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ],
          "assets": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ],
          "invested": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ],
          "rescued": [
            {
              "allocation": "number",
              "deadline_fixed_income": "string",
              "disclaimer": "string",
              "fee_fixed_income": "string",
              "financial_balance": "number",
              "id": "string",
              "minimum_value": "number",
              "name": "string",
              "percentage": "string",
              "risk": "string",
              "type": "string",
              "benchmarks": "object",
              "new_benchmarks": "object"
            }
          ]
        }
      ],
      "projections": "array",
      "value_achive_goal": "number",
      "deadline_achive_goal": "integer",
      "gross_value": "number",
      "name": "string",
      "net_value": "number"
    }
  ]
}

Redistribuitions: object

products: ProductsV2

Produtos da carteira

ProductsV2
projections: array

Array com as projeções mensais. Ideal para a plotagem do gráfico

value_achive_goal: number

Valor da carteira no prazo que irá atingir a meta financeira

deadline_achive_goal: integer

Prazo que o cliente conseguirá atingir a meta financeira

gross_value: number

Valor Bruto

name: string

Nome da projeção (Investimento, Poupança, CDI, Ibovespa)

net_value: number

Valor Líquido

Example
{
  "products": [
    {
      "added": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "assets": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "invested": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "rescued": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ]
    }
  ],
  "projections": "array",
  "value_achive_goal": "number",
  "deadline_achive_goal": "integer",
  "gross_value": "number",
  "name": "string",
  "net_value": "number"
}

V3BalanceRequest: object

client_id: string

ID do Cliente

investment_profile: string

Perfil de Investidor

rescue_automatic: boolean

Resgate automático na data de vencimento dos títulos de renda fixa?

investments: InvestmentsV3Rentability
InvestmentsV3Rentability
products: AllProductsAdd

Informações dos produtos

AllProductsAdd
Example
{
  "client_id": "string",
  "investment_profile": "string",
  "rescue_automatic": "boolean",
  "investments": [
    {
      "id": "string",
      "name": "string",
      "deadline": "integer",
      "deduce_income_tax": "string",
      "deduce_quota_eating": "string",
      "financial_goal": "number",
      "full_percentage_cdi": "string",
      "initial_capital": "number",
      "investment_period": "number",
      "max_deadline": "integer",
      "lock_deadline": "string",
      "closest_due_date": "string",
      "products": [
        {
          "id": "string",
          "initial_capital": "number",
          "investment_date": "date (DD/MM/YYYY)",
          "name": "string",
          "fixed_incomes": "boolean",
          "type": "string",
          "indexer": "string",
          "fee": "number",
          "daily_liquidity": "boolean",
          "deadline": "integer",
          "minimum_value": "number",
          "add": [
            {
              "value": "number",
              "date": "number"
            }
          ],
          "rescue": [
            {
              "value": "number",
              "date": "number"
            }
          ]
        }
      ]
    }
  ],
  "products": [
    {
      "id": "string",
      "balance": "number",
      "investment_date": "date (DD/MM/YYYY)",
      "name": "string",
      "fixed_incomes": "boolean",
      "type": "string",
      "indexer": "string",
      "fee": "number",
      "daily_liquidity": "boolean",
      "deadline": "integer",
      "minimum_value": "number"
    }
  ]
}

V3RescueRequest: object

client_id: string

ID do Cliente

investment_profile: string

Perfil de Investidor

rescue_value: number

Valor do Resgate

rescue_automatic: boolean

Resgate automático na data de vencimento dos títulos de renda fixa?

investments: InvestmentsV3Rentability
InvestmentsV3Rentability
products: AllProductsAdd

Informações dos produtos

AllProductsAdd
Example
{
  "client_id": "string",
  "investment_profile": "string",
  "rescue_value": "number",
  "rescue_automatic": "boolean",
  "investments": [
    {
      "id": "string",
      "name": "string",
      "deadline": "integer",
      "deduce_income_tax": "string",
      "deduce_quota_eating": "string",
      "financial_goal": "number",
      "full_percentage_cdi": "string",
      "initial_capital": "number",
      "investment_period": "number",
      "max_deadline": "integer",
      "lock_deadline": "string",
      "closest_due_date": "string",
      "products": [
        {
          "id": "string",
          "initial_capital": "number",
          "investment_date": "date (DD/MM/YYYY)",
          "name": "string",
          "fixed_incomes": "boolean",
          "type": "string",
          "indexer": "string",
          "fee": "number",
          "daily_liquidity": "boolean",
          "deadline": "integer",
          "minimum_value": "number",
          "add": [
            {
              "value": "number",
              "date": "number"
            }
          ],
          "rescue": [
            {
              "value": "number",
              "date": "number"
            }
          ]
        }
      ]
    }
  ],
  "products": [
    {
      "id": "string",
      "balance": "number",
      "investment_date": "date (DD/MM/YYYY)",
      "name": "string",
      "fixed_incomes": "boolean",
      "type": "string",
      "indexer": "string",
      "fee": "number",
      "daily_liquidity": "boolean",
      "deadline": "integer",
      "minimum_value": "number"
    }
  ]
}

V3RescueResponse: object

deadline: integer

Prazo

financial_assets: ProductsV2

Produtos da carteira

ProductsV2
id: string

ID da carteira

initial_capital: number

Capital Inicial

name: string

Nome da carteira

Example
{
  "deadline": "integer",
  "financial_assets": [
    {
      "added": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "assets": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "invested": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ],
      "rescued": [
        {
          "allocation": "number",
          "deadline_fixed_income": "string",
          "disclaimer": "string",
          "fee_fixed_income": "string",
          "financial_balance": "number",
          "id": "string",
          "minimum_value": "number",
          "name": "string",
          "percentage": "string",
          "risk": "string",
          "type": "string",
          "benchmarks": "object",
          "new_benchmarks": "object"
        }
      ]
    }
  ],
  "id": "string",
  "initial_capital": "number",
  "name": "string"
}

V3RentabilityResponse: object

benchmarks: object

Benchmark de todas as carteiras em relação CDI e IBOVESPA do mês corrente e mês anterior

gain: Gain

Ganho de todas das carteiras do mês corrente e mês anterior

Gain
gross_value_accumulated: number

Valor acumulado bruto de todas as carteiras

initial_capital: number

Somatório do capital inicial de todas as carteiras

investment_capital: number

Somatório do capital mensal de todas as carteiras

rentabilities_investments: InvestmentsRentability

Carteiras do Cliente

InvestmentsRentability
Example
{
  "benchmarks": "object",
  "gain": [
    {
      "value": "number",
      "percentage": "number",
      "date": "number"
    }
  ],
  "gross_value_accumulated": "number",
  "initial_capital": "number",
  "investment_capital": "number",
  "rentabilities_investments": [
    {
      "accumulated_mensal_capital": "number",
      "gross_value_accumulated": "number",
      "id": "string",
      "initial_capital": "number",
      "name": "string",
      "investment_capital": "number",
      "rescue_accumulated": "number",
      "gain": [
        {
          "value": "number",
          "percentage": "number",
          "date": "number"
        }
      ],
      "benchmarks_class_product": "object",
      "rentabilities_product": [
        {
          "balance": "number",
          "gain": "object",
          "id": "string",
          "initial_capital": "number",
          "investment_date": "date (DD/MM/YYYY)",
          "name": "string",
          "fixed_incomes": "boolean",
          "type": "string",
          "indexer": "string",
          "fee": "number",
          "daily_liquidity": "boolean",
          "deadline": "integer",
          "minimum_value": "number",
          "value_accumulated": "number",
          "rentabilities": [
            {
              "add": "number",
              "benchmark": "object",
              "gain": "object",
              "date": "date (DD/MM/YYYY)",
              "deadline": "integer",
              "mensal_capital": "number",
              "value_accumulated": "number",
              "rescue": "number"
            }
          ]
        }
      ]
    }
  ]
}

Gain: object

value: number

Valor do ganho

percentage: number

Porcentagem de ganho em relação ao período antecessor

date: number

Período do ganho

Example
{
  "value": "number",
  "percentage": "number",
  "date": "number"
}

InvestmentsRentability: object

accumulated_mensal_capital: number

Somatório do capital investido de todas as carteiras

gross_value_accumulated: number

Valor acumulado bruto de todas as carteiras

id: string

ID da carteira

initial_capital: number

Capital Inicial

name: string

Nome da carteira

investment_capital: number

Capital Mensal

rescue_accumulated: number

Valor acumulado dos resgates

gain: Gain

Ganho da carteira em todos os períodos desejados

Gain
benchmarks_class_product: Gain

Benchmark e ganho de cada tipo e classe de ativo

rentabilities_product: RentabilitiesProduct

Rentabilidade, ganho e outras informações de cada produto da carteira

RentabilitiesProduct
Example
{
  "accumulated_mensal_capital": "number",
  "gross_value_accumulated": "number",
  "id": "string",
  "initial_capital": "number",
  "name": "string",
  "investment_capital": "number",
  "rescue_accumulated": "number",
  "gain": [
    {
      "value": "number",
      "percentage": "number",
      "date": "number"
    }
  ],
  "benchmarks_class_product": "object",
  "rentabilities_product": [
    {
      "balance": "number",
      "gain": "object",
      "id": "string",
      "initial_capital": "number",
      "investment_date": "date (DD/MM/YYYY)",
      "name": "string",
      "fixed_incomes": "boolean",
      "type": "string",
      "indexer": "string",
      "fee": "number",
      "daily_liquidity": "boolean",
      "deadline": "integer",
      "minimum_value": "number",
      "value_accumulated": "number",
      "rentabilities": [
        {
          "add": "number",
          "benchmark": "object",
          "gain": "object",
          "date": "date (DD/MM/YYYY)",
          "deadline": "integer",
          "mensal_capital": "number",
          "value_accumulated": "number",
          "rescue": "number"
        }
      ]
    }
  ]
}

RentabilitiesProduct: object

balance: number

Saldo atual do produto

gain: object

Ganho e porcentagem de ganho atual

id: string

ID

initial_capital: number

Capital investido no produto

investment_date: date (DD/MM/YYYY)

Data da Aplicação

name: string

Nome

fixed_incomes: boolean

É Título de Renda Fixa?

type: string

Tipo Título de Renda Fixa (PRE / POS)

indexer: string

Indexador Título de Renda Fixa

fee: number

Taxa Título de Renda Fixa

daily_liquidity: boolean

É liquidez diária?

deadline: integer

Prazo Título de Renda Fixa

minimum_value: number

Valor mínimo de aplicação Título de Renda Fixa

value_accumulated: number

Valor acumulado bruto

rentabilities: Rentabilities

Rentabilidade, ganho e outras informações do produto em cada período desejado

Rentabilities
Example
{
  "balance": "number",
  "gain": "object",
  "id": "string",
  "initial_capital": "number",
  "investment_date": "date (DD/MM/YYYY)",
  "name": "string",
  "fixed_incomes": "boolean",
  "type": "string",
  "indexer": "string",
  "fee": "number",
  "daily_liquidity": "boolean",
  "deadline": "integer",
  "minimum_value": "number",
  "value_accumulated": "number",
  "rentabilities": [
    {
      "add": "number",
      "benchmark": "object",
      "gain": "object",
      "date": "date (DD/MM/YYYY)",
      "deadline": "integer",
      "mensal_capital": "number",
      "value_accumulated": "number",
      "rescue": "number"
    }
  ]
}

Rentabilities: object

add: number

Valor de aporte naquele período

benchmark: object

Benchmark no perído

gain: object

Ganho e porcentagem de ganho no período

date: date (DD/MM/YYYY)

Data do Período

deadline: integer

Prazo Título de Renda Fixa

mensal_capital: number

Capital mensal

value_accumulated: number

Valor acumulado bruto

rescue: number

Valor de resgate naquele período

Example
{
  "add": "number",
  "benchmark": "object",
  "gain": "object",
  "date": "date (DD/MM/YYYY)",
  "deadline": "integer",
  "mensal_capital": "number",
  "value_accumulated": "number",
  "rescue": "number"
}

V3Quota: object

product_id: string

ID do produto

cnpj: string

CNPJ

quota: number

Valor da cota

quota_date: date (DD/MM/YYYY)

Data da cota

Example
{
  "product_id": "string",
  "cnpj": "string",
  "quota": "number",
  "quota_date": "date (DD/MM/YYYY)"
}