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

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

The period that data is partitioned into

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

The start date of the report, inclusive

end_date
string
required

The end date of the report, inclusive

Response

200 - application/json
entries
object[]
required
summary
object
required
Get Gross Profit by PeriodCreate Transactions