finance 1.0 · Pessoa
Retrato economico de um CPF: renda estimada convertida em reais, patrimonio, historico de declaracao de imposto de renda, historico de cobranca e beneficios sociais com extrato de pagamentos.
| Entidade | Pessoa (CPF, entity: pf) |
| Módulo | finance |
| Versão | 1.0 |
| Dataset | person-finance-1.0 |
| Execução | Roda quando o perfil inclui o módulo |
Este é o formato do corpo de GET /api/v3/enrichments/{id}/modules/finance, a rota que a url do módulo, na raiz do enriquecimento, aponta. Os campos são publicados como o dataset os entrega: um campo ausente significa que o dado não foi obtido, não que o valor é falso ou zero. Os caminhos abaixo são relativos ao corpo da resposta.
Envelope
| Campo | Tipo | Observação |
|---|---|---|
dataset | string | sempre person-finance-1.0 |
module | string | sempre finance |
finance | object | os dados do módulo (abaixo) |
Dados
income
| Campo | Tipo | Observação |
|---|---|---|
finance.income.monthlyBRL | number | |
finance.income.band | string | |
finance.income.basis | string | |
finance.assets | string |
taxReturns
| Campo | Tipo | Observação |
|---|---|---|
finance.taxReturns.years | integer | |
finance.taxReturns.filed | integer | |
finance.taxReturns.latest | string | |
finance.taxReturns.items | array<object> | |
finance.taxReturns.items[].bank | string | |
finance.taxReturns.items[].filed | boolean | |
finance.taxReturns.items[].status | string | |
finance.taxReturns.items[].updatedAt | string | date |
finance.taxReturns.items[].year | string |
debts
| Campo | Tipo | Observação |
|---|---|---|
finance.debts.current | boolean | |
finance.debts.months | integer | |
finance.debts.consecutiveMonths | integer | |
finance.debts.maxConsecutiveMonths | integer | |
finance.debts.occurrences | integer | |
finance.debts.origins | integer | |
finance.debts.last30Days | integer | |
finance.debts.last90Days | integer | |
finance.debts.last180Days | integer | |
finance.debts.last365Days | integer | |
finance.debts.firstAt | string | date |
finance.debts.lastAt | string | date |
assistance
| Campo | Tipo | Observação |
|---|---|---|
finance.assistance.receiving | boolean | |
finance.assistance.total | integer | |
finance.assistance.active | integer | |
finance.assistance.amountReceived | number | |
finance.assistance.installments | integer | |
finance.assistance.items | array<object> | |
finance.assistance.items[].active | boolean | |
finance.assistance.items[].amount | number | |
finance.assistance.items[].city | string | |
finance.assistance.items[].context | string | |
finance.assistance.items[].endDate | string | date |
finance.assistance.items[].installments | integer | |
finance.assistance.items[].name | string | |
finance.assistance.items[].payments | object | |
finance.assistance.items[].payments.count | integer | |
finance.assistance.items[].payments.duplicateReferenceDates | integer | |
finance.assistance.items[].payments.first | number | |
finance.assistance.items[].payments.items | array<object> | |
finance.assistance.items[].payments.items[].month | string | |
finance.assistance.items[].payments.last | number | |
finance.assistance.items[].payments.sum | number | |
finance.assistance.items[].payments.values | array<object> | |
finance.assistance.items[].payments.values[].count | integer | |
finance.assistance.items[].payments.values[].value | number | |
finance.assistance.items[].startDate | string | date |
finance.assistance.items[].state | string | |
finance.assistance.items[].totalAmount | number |
timeline
| Campo | Tipo | Observação |
|---|---|---|
finance.timeline | array<object> | |
finance.timeline[].amountBrl | number | |
finance.timeline[].basis | string | |
finance.timeline[].date | string | |
finance.timeline[].detail | string | |
finance.timeline[].event | string | |
finance.timeline[].precision | string | |
finance.timeline[].ref | string | |
finance.timeline[].source | string |