API Documentation

Welcome to the Baalvion API. Integrate your applications with our platform.

Businesses

GET

/api/businesses

Returns a list of all businesses in your portfolio.

Parameters

Name	Type	Required	Description
limit	integer	No	The number of businesses to return.
offset	integer	No	The offset for pagination.

Example Request

curl https://api.baalvion.com/v1/businesses

Example Response

[
  {
    "id": "biz_1",
    "name": "TechCorp India",
    "country": "India",
    "status": "Growth"
  },
  {
    "id": "biz_2",
    "name": "Baalvion Media UK",
    "country": "United Kingdom",
    "status": "Active"
  }
]

GET

/api/businesses/{id}

Retrieves the details of a specific business by its ID.

Parameters

Name	Type	Required	Description
id	string	Yes	The ID of the business to retrieve.

Example Request

curl https://api.baalvion.com/v1/businesses/biz_1

Example Response

{
  "id": "biz_1",
  "name": "TechCorp India",
  "country": "India",
  "currency": "INR",
  "status": "Growth",
  "currentMetrics": {
    "revenue": 75000000,
    "profit": 15000000,
    "employees": 120
  }
}

Employees

GET

/api/employees

Returns a paginated list of all employees.

Parameters

Name	Type	Required	Description
page	integer	No	The page number for pagination.
businessId	string	No	Filter employees by business ID.

Example Request

curl https://api.baalvion.com/v1/employees?page=1&businessId=biz_1

Example Response

[
  {
    "id": "emp_002",
    "name": "Priya Sharma",
    "email": "priya.sharma@techcorp.com",
    "role": "Managing Director"
  }
]

GET

/api/employees/{id}

Retrieves the details of a specific employee.

Parameters

Name	Type	Required	Description
id	string	Yes	The ID of the employee to retrieve.

Example Request

curl https://api.baalvion.com/v1/employees/emp_002

Example Response

{
  "id": "emp_002",
  "name": "Priya Sharma",
  "email": "priya.sharma@techcorp.com",
  "role": "Managing Director",
  "department": "Management",
  "businessId": "biz_1",
  "country": "India"
}

Finance

GET

/api/finance/overview

Returns a high-level financial overview of the entire portfolio.

Example Request

curl https://api.baalvion.com/v1/finance/overview

Example Response

{
  "netWorth": {
    "total": 24600000,
    "change": {
      "amount": 340000,
      "percentage": 1.4
    }
  },
  "totalRevenue": 4301411
}

GET

/api/transactions

Returns a paginated list of financial transactions.

Parameters

Name	Type	Required	Description
limit	integer	No	Number of transactions to return.
status	string	No	Filter by status (Success, Failed, Pending).

Example Request

curl https://api.baalvion.com/v1/transactions?limit=2&status=Success

Example Response

[
  {
    "id": "txn_01",
    "businessId": "biz_1",
    "amount": 50000,
    "currency": "INR",
    "status": "Success"
  },
  {
    "id": "txn_02",
    "businessId": "biz_4",
    "amount": 1200,
    "currency": "USD",
    "status": "Success"
  }
]

POST

/api/reports

Generates a new financial report.

Parameters

Name	Type	Required	Description
type	string	Yes	Type of report (e.g., 'pnl', 'executive').
period	string	Yes	The reporting period (e.g., 'Q3 2024').

Example Request

curl -X POST https://api.baalvion.com/v1/reports \
 -H "Content-Type: application/json" \
 -d '{
   "type": "pnl",
   "period": "July 2024"
 }'

Example Response

{
  "reportId": "rep_11",
  "status": "generating",
  "message": "Report generation has started."
}

GET

/api/equity

Returns the equity distribution for all businesses.

Example Request

curl https://api.baalvion.com/v1/equity

Example Response

[
  {
    "businessId": "biz_1",
    "valuation": 60000000,
    "stakeholders": [
      {
        "name": "Priya Sharma",
        "equity": 40
      }
    ]
  }
]