Get the financial overview
curl --request GET \
--url https://api.visorfinance.app/v1/spaces/{space_id}/overview \
--header 'Authorization: Bearer <token>'{
"data": {
"bank_balance": "5230.40",
"credit_card_debt": "1840.00",
"currency_code": "BRL",
"net_worth": "3390.40",
"open_bills_total": "2310.90",
"period": {
"expenses": "4210.35",
"income": "7500.00",
"result": "3289.65"
},
"period_end": "2026-10-31",
"period_start": "2026-10-01",
"projection": {
"committed_outflows": {
"bills": "1840.00",
"installments": "320.00",
"scheduled": "0.00",
"subscriptions": "450.00"
},
"current_balance": "5230.40",
"estimated_day_to_day": "600.00",
"expected_income": "2000.00",
"projected_balance": "4020.40"
},
"upcoming_bills": [
{
"account_id": "5d3a9c1e-2b4f-4e6a-8c7d-1f0e9b2a3c45",
"amount": "1840.00",
"amount_is_estimate": true,
"description": "Nubank",
"due_date": "2026-10-28"
}
]
}
}{
"errors": [
{
"code": "INVALID_TOKEN",
"details": {},
"message": "The personal API token is not valid.",
"request_id": "F8x2kQ9vXc1AAAAB"
}
]
}{
"errors": [
{
"code": "INSUFFICIENT_SCOPE",
"details": {
"required_scope": "pfm:read"
},
"message": "The personal API token does not grant this operation.",
"request_id": "F8x2kQ9vXc1AAAAB"
}
]
}{
"errors": [
{
"code": "NOT_FOUND",
"details": {},
"message": "The resource does not exist.",
"request_id": "F8x2kQ9vXc1AAAAB"
}
]
}{
"errors": [
{
"code": "INVALID_TOKEN",
"details": {},
"message": "<string>",
"request_id": "<string>"
}
]
}{
"errors": [
{
"code": "RATE_LIMITED",
"details": {
"retry_after_seconds": 42
},
"message": "Too many requests. Retry after the number of seconds in Retry-After.",
"request_id": "F8x2kQ9vXc1AAAAB"
}
]
}Overview
Get the financial overview
Returns the financial snapshot of a space for its current financial period (the space’s month start, not the calendar month): balances, net worth, card bills due in the next 30 days, period income and expenses, and the projected balance at the end of the period with its components. Amounts are decimal strings in the user’s display currency. Requires the pfm:read scope.
Get the financial overview
curl --request GET \
--url https://api.visorfinance.app/v1/spaces/{space_id}/overview \
--header 'Authorization: Bearer <token>'{
"data": {
"bank_balance": "5230.40",
"credit_card_debt": "1840.00",
"currency_code": "BRL",
"net_worth": "3390.40",
"open_bills_total": "2310.90",
"period": {
"expenses": "4210.35",
"income": "7500.00",
"result": "3289.65"
},
"period_end": "2026-10-31",
"period_start": "2026-10-01",
"projection": {
"committed_outflows": {
"bills": "1840.00",
"installments": "320.00",
"scheduled": "0.00",
"subscriptions": "450.00"
},
"current_balance": "5230.40",
"estimated_day_to_day": "600.00",
"expected_income": "2000.00",
"projected_balance": "4020.40"
},
"upcoming_bills": [
{
"account_id": "5d3a9c1e-2b4f-4e6a-8c7d-1f0e9b2a3c45",
"amount": "1840.00",
"amount_is_estimate": true,
"description": "Nubank",
"due_date": "2026-10-28"
}
]
}
}{
"errors": [
{
"code": "INVALID_TOKEN",
"details": {},
"message": "The personal API token is not valid.",
"request_id": "F8x2kQ9vXc1AAAAB"
}
]
}{
"errors": [
{
"code": "INSUFFICIENT_SCOPE",
"details": {
"required_scope": "pfm:read"
},
"message": "The personal API token does not grant this operation.",
"request_id": "F8x2kQ9vXc1AAAAB"
}
]
}{
"errors": [
{
"code": "NOT_FOUND",
"details": {},
"message": "The resource does not exist.",
"request_id": "F8x2kQ9vXc1AAAAB"
}
]
}{
"errors": [
{
"code": "INVALID_TOKEN",
"details": {},
"message": "<string>",
"request_id": "<string>"
}
]
}{
"errors": [
{
"code": "RATE_LIMITED",
"details": {
"retry_after_seconds": 42
},
"message": "Too many requests. Retry after the number of seconds in Retry-After.",
"request_id": "F8x2kQ9vXc1AAAAB"
}
]
}Was this page helpful?