GET
/
v0
/
reports
/
financial-summaries-by-period
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/reports/financial-summaries-by-period \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "summary": {
    "revenue": 120000,
    "expense": 60000,
    "operating_revenue": 100000,
    "cost_of_goods_sold": 30000,
    "gross_profit": 70000,
    "percent_gross_margin": 70,
    "net_profit": 60000,
    "percent_profit_margin": 50
  },
  "entries": [
    {
      "period": "Jan 2024",
      "totals": {
        "revenue": 120000,
        "expense": 60000,
        "operating_revenue": 100000,
        "cost_of_goods_sold": 30000,
        "gross_profit": 70000,
        "percent_gross_margin": 70,
        "net_profit": 60000,
        "percent_profit_margin": 50
      }
    }
  ]
}

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

teal-instance-id
string
required

The Teal instance ID

Query Parameters

period
enum<string>
required

Determines how the data is segmented.

Available options:
daily,
monthly,
quarterly,
yearly
start_date
string
required

Only include data after the start date (inclusive).

end_date
string
required

Only include data before the end date (inclusive).

tag_ids
string

Comma-separated list of tag ids for filtering .Requires a Tier 3 subscription

Response

200 - application/json
summary
object
required

The financial summary for the period.

entries
object[]
required

A list of report summary totals broken down by period between the start date and end date.