Skip to main content
GET
/
financials
/
details
/
{project_id}
Get Detailed Financial Information
curl --request GET \
  --url https://api.terraspect.earth/financials/details/{project_id} \
  --header 'Authorization: Bearer <token>'
{
  "project_id": "proj_789012",
  "revenue_share_percentage": 30.5,
  "payment_types": {
    "planting": 5000,
    "labour": 3000,
    "lease": 2000,
    "revenue-share": 10000,
    "equipment": 4000,
    "expenses": 1500,
    "training": 2500,
    "seedlings": 1200,
    "technical": 3000,
    "health": 500,
    "audit": 1000,
    "taxes": 600,
    "maintenance": 700,
    "loans": 800,
    "savings": 900,
    "insurance": 1000,
    "pension": 1100
  },
  "payment_distribution": {
    "payment_direct": 70,
    "payment_group": 30
  },
  "payment_methods": {
    "payment_mobile_money": 60,
    "payment_bank_transfer": 35,
    "payment_unknown": 5
  },
  "payment_frequency": 30,
  "revenue_share_amount_usd": 1500000,
  "total_community_income_usd": 2000000
}

Authorizations

​
Authorization
string
header
required

Extended access token required for more sensitive data, in the format Authorization: Bearer <token>

Path Parameters

​
project_id
string<uuid>
required

Unique identifier of the project

Query Parameters

​
start_date
string<date>

Start date for financial data (ISO 8601 format)

Example:

"2024-01-01"

​
end_date
string<date>

End date for financial data (ISO 8601 format)

Example:

"2024-12-31"

Response

Detailed financial information successfully retrieved

​
project_id
string
required

Project identifier

Example:

"proj_789012"

​
revenue_share_percentage
number
required

Percentage of revenue shared with community

Required range: 0 <= x <= 100
Example:

30.5

​
payment_types
object
required

Breakdown of different payment types and their amounts

Example:
{
  "planting": 5000,
  "labour": 3000,
  "lease": 2000,
  "revenue-share": 10000,
  "equipment": 4000,
  "expenses": 1500,
  "training": 2500,
  "seedlings": 1200,
  "technical": 3000,
  "health": 500,
  "audit": 1000,
  "taxes": 600,
  "maintenance": 700,
  "loans": 800,
  "savings": 900,
  "insurance": 1000,
  "pension": 1100
}
​
payment_distribution
object
required
​
payment_methods
object
required
​
payment_frequency
integer
required

Average payment frequency in days

Required range: x >= 1
Example:

30

​
revenue_share_amount_usd
number

Total amount shared with community in USD

Example:

1500000

​
total_community_income_usd
number

Total income received by community in USD

Example:

2000000