Revenue

Historical revenue data and projections for corporate accounts.

Overview

The /revenue endpoint returns the real-time revenue of a corporate entity connected to your Okra account.

curl -X POST https://api.okra.ng/v2/revenue/${route}
-H 'Content-Type: application/json' 
-H 'Authorisation: Bearer <secretKey>'
{
    "company_name": "Name of Company",
    "average_confidence": xxx,
    "last_years_revenue": xxx,
    "current_year_revenue_projection": xxx,
    "last_two_years_to_date_revenue_projection": xxx,
    "last_year_to_date_revenue_projection:: xxx
    "revenue_breakdown": [
        {
            "year": 2020,
            "monthly_breakdowns": [
                "jan": {
                    "revenue": {
                        "naira": xxx,
                        "dollar": xxx,
                        "euros" xxx,
                    },
                    "number_of_employees": 20,
                    "corporate_tax": {
                        "naira": xxx,
                        "dollar": xxx,
                        "euros": xxx
                    }
                }
                "feb": {...}
            ]
            "confidence": xxx
        }
    ]
}

Request payload

Definition of All Payload Items from the Routes Below.

KeyDescriptionDefault
page
Number
Page of list you would like to fetch1
limit
Number
Number of records you would like to fetch20
pdf
Boolean
Send back as PDFfalse
to
Date
YYYY-MM-DD
from
Date
YYYY-MM-DD
customer_id
ObjectId
Customer's Okra Unique ID

Retrieve revenue by value

Use the baseURL <https://api.okra.ng/v2/revenue> and append with any of the available routes.

RoutePayload
/processcustomer_id
pdf
/listpage
limit
pdf
/getByCustomercustomer_id
pdf
/getByCustomerDatecustomer_id
to
from
pdf

📘

Make a revenue request in real-time, from our API Reference.