Reports
In this section we will present the reports provided to investment funds and the step-by-step process that enables the download of reports.
To access these reports, contact the team integracao.dtvm@qitech.com.br, so that the necessary permissions can be granted in the Sandbox environment and subsequently in the production environment.
The reports provided by QI CTVM include information about portfolio composition, asset movements, profitability, investor positions, and cash flow. These reports allow managers to make informed decisions, maintain and ensure transparency and compliance with regulations.
SFTP Access
SFTP (Secure File Transfer Protocol) is the protocol used to make QI CTVM reports available. To integrate with SFTP, it is recommended to use libraries and tools that support the protocol, such as paramiko for Python or standard SFTP clients.
Credentials Format
To connect to the SFTP, the following credentials will be required, which will be provided by QI CTVM:
- HOSTNAME: SFTP server address
- PORT: connection port (default 22)
- USERNAME: user for authentication
- SSH PRIVATE KEY: private key in PEM format for authentication
These credentials provide direct access to the provided reports and should not be shared.
Code Example
Making the connection and download
- Python
import paramiko
hostname = "sftp.exemplo.com"
port = 22
username = "usuario"
key_file = "/caminho/para/sua_chave_privada.pem"
# Carrega a chave privada
key = paramiko.RSAKey.from_private_key_file(key_file)
# Conecta ao servidor
transport = paramiko.Transport((hostname, port))
transport.connect(username=username, pkey=key)
# Cria o cliente SFTP
sftp = paramiko.SFTPClient.from_transport(transport)
# Lista arquivos disponíveis
files = sftp.listdir("/")
for f in files:
print(f)
# Faz download de um arquivo
sftp.get("remote_path/arquivo.csv", "local_path/arquivo.csv")
sftp.close()
transport.close()
Downloading
After receiving the credentials, it is possible to download the file given the fund short name, the report model and the date of interest in YYYY-MM-DD format as per the example:
- nome_exemplo_amortization_2024-01-01
The SFTP service provided is exclusively for downloading files; upload is not permitted.
Example Files
All report examples are at: relatórios
Report Types
| Model | Description | File format |
|---|---|---|
admin_fee_calc | Administration fee calculation | CSV |
amortization | Fund amortization history | CSV |
cash_account_demonstrative | Cash statement at end of day | XLSX |
cash_account_demonstrative_movements | Cash movement statement throughout the day | CSV |
assets_wallet_composition | All assets that compose the inventory on a given day | CSV |
assignment_assets_wallet_composition | All installments of a credit rights assignment | CSV |
credit_rights_acquisition_assets | All credit operations acquired on a given day | CSV |
credit_rights_acquisition_installments | All installments of credit operations acquired on a given day | CSV |
credit_rights_conciliation_assets | All credit operations that were paid on a given day | CSV |
credit_rights_conciliation_installments | All installments of credit operations that were paid on a given day | CSV |
discounted_credit_rights_acquisition_assets | All invoices acquired on a given day | CSV |
discounted_credit_rights_conciliation_assets | All invoices that were paid on a given day | CSV |
investor_position_csv | Investor position report for the day | CSV |
pdd_calc | Provision for doubtful debtors calculation | CSV |
pmts_reconciliation | Payments made on the date | XLSX |
wallet_composition | Portfolio composition at end of day | XLSX |
wallet_composition_fund_quotas | Fund quota composition in portfolio at end of day | CSV |