GET
/
v0
/
reports
/
income-statement
/
range
Retrieve the income statements periods for a given range
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/reports/income-statement/range \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "periods": [
    "Q1-2020",
    "Q2-2020"
  ],
  "records": [
    {
      "amounts": [
        0,
        0
      ],
      "children": [
        {
          "amounts": [
            262469.88,
            272321.32
          ],
          "debit_credit": "credit",
          "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
          "name": "Sales Revenue",
          "sort_code": "4100",
          "sub_type": "operating_revenues",
          "total_amounts": [
            262469.88,
            272321.32
          ],
          "type": "revenue"
        }
      ],
      "debit_credit": "credit",
      "name": "Operating Revenues",
      "total_amounts": [
        262469.88,
        272321.32
      ],
      "type": "revenue"
    },
    {
      "amounts": [
        262469.88,
        272321.32
      ],
      "debit_credit": "credit",
      "name": "Total Net Sales",
      "total_amounts": [
        262469.88,
        272321.32
      ]
    },
    {
      "amounts": [
        0,
        0
      ],
      "children": [
        {
          "amounts": [
            134929.69,
            144421.61
          ],
          "debit_credit": "debit",
          "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco",
          "name": "Cost Of Goods Sold",
          "sort_code": "5100",
          "sub_type": "cost_of_goods_sold",
          "total_amounts": [
            134929.69,
            144421.61
          ],
          "type": "expense"
        }
      ],
      "debit_credit": "debit",
      "name": "Cost Of Goods Sold",
      "total_amounts": [
        134929.69,
        144421.61
      ],
      "type": "expense"
    },
    {
      "amounts": [
        127540.19,
        127899.71
      ],
      "debit_credit": "credit",
      "name": "Gross Profit",
      "total_amounts": [
        127540.19,
        127899.71
      ]
    },
    {
      "amounts": [
        0,
        0
      ],
      "children": [
        {
          "amounts": [
            86276.92,
            87271.31
          ],
          "debit_credit": "debit",
          "ledger_id": "WhvrC7XAES1fDrpWWgmPtg",
          "name": "Salaries And Wages Expense",
          "sort_code": "5300",
          "sub_type": "operating_expenses",
          "total_amounts": [
            86276.92,
            87271.31
          ],
          "type": "expense"
        }
      ],
      "debit_credit": "debit",
      "name": "Operating Expenses",
      "total_amounts": [
        86276.92,
        87271.31
      ],
      "type": "expense"
    },
    {
      "amounts": [
        41263.27,
        40628.4
      ],
      "debit_credit": "credit",
      "name": "Total Operating Profit",
      "total_amounts": [
        41263.27,
        40628.4
      ]
    },
    {
      "amounts": [
        0,
        0
      ],
      "debit_credit": "debit",
      "name": "Other Expenses",
      "total_amounts": [
        0,
        0
      ],
      "type": "expense"
    },
    {
      "amounts": [
        0,
        0
      ],
      "debit_credit": "credit",
      "name": "Other Income",
      "total_amounts": [
        0,
        0
      ],
      "type": "revenue"
    },
    {
      "amounts": [
        41263.27,
        40628.4
      ],
      "debit_credit": "credit",
      "name": "Net Profit",
      "total_amounts": [
        41263.27,
        40628.4
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

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

range_start
string
required

The start of the time range. yyyy for yearly period, yyyy-MM for monthly period, yyyy-Q{1-4} for quarterly period, yyyy-MM-dd otherwise.

range_end
string
required

The end of the time range. yyyy for yearly period, yyyy-MM for monthly period, yyyy-Q{1-4} for quarterly period, yyyy-MM-dd otherwise.

period
enum<string> | null

The interval of the periods. If no period is provided the entire range will be returned as a single period.

Available options:
daily,
monthly,
quarterly,
yearly
time_zone
enum<string>
default:UTC

Time Zone Identifier

Available options:
Africa/Abidjan,
Africa/Accra,
Africa/Addis_Ababa,
Africa/Algiers,
Africa/Asmara,
Africa/Asmera,
Africa/Bamako,
Africa/Bangui,
Africa/Banjul,
Africa/Bissau,
Africa/Blantyre,
Africa/Brazzaville,
Africa/Bujumbura,
Africa/Cairo,
Africa/Casablanca,
Africa/Ceuta,
Africa/Conakry,
Africa/Dakar,
Africa/Dar_es_Salaam,
Africa/Djibouti,
Africa/Douala,
Africa/El_Aaiun,
Africa/Freetown,
Africa/Gaborone,
Africa/Harare,
Africa/Johannesburg,
Africa/Juba,
Africa/Kampala,
Africa/Khartoum,
Africa/Kigali,
Africa/Kinshasa,
Africa/Lagos,
Africa/Libreville,
Africa/Lome,
Africa/Luanda,
Africa/Lubumbashi,
Africa/Lusaka,
Africa/Malabo,
Africa/Maputo,
Africa/Maseru,
Africa/Mbabane,
Africa/Mogadishu,
Africa/Monrovia,
Africa/Nairobi,
Africa/Ndjamena,
Africa/Niamey,
Africa/Nouakchott,
Africa/Ouagadougou,
Africa/Porto-Novo,
Africa/Sao_Tome,
Africa/Timbuktu,
Africa/Tripoli,
Africa/Tunis,
Africa/Windhoek,
America/Adak,
America/Anchorage,
America/Anguilla,
America/Antigua,
America/Araguaina,
America/Argentina/Buenos_Aires,
America/Argentina/Catamarca,
America/Argentina/ComodRivadavia,
America/Argentina/Cordoba,
America/Argentina/Jujuy,
America/Argentina/La_Rioja,
America/Argentina/Mendoza,
America/Argentina/Rio_Gallegos,
America/Argentina/Salta,
America/Argentina/San_Juan,
America/Argentina/San_Luis,
America/Argentina/Tucuman,
America/Argentina/Ushuaia,
America/Aruba,
America/Asuncion,
America/Atikokan,
America/Atka,
America/Bahia,
America/Bahia_Banderas,
America/Barbados,
America/Belem,
America/Belize,
America/Blanc-Sablon,
America/Boa_Vista,
America/Bogota,
America/Boise,
America/Buenos_Aires,
America/Cambridge_Bay,
America/Campo_Grande,
America/Cancun,
America/Caracas,
America/Catamarca,
America/Cayenne,
America/Cayman,
America/Chicago,
America/Chihuahua,
America/Ciudad_Juarez,
America/Coral_Harbour,
America/Cordoba,
America/Costa_Rica,
America/Coyhaique,
America/Creston,
America/Cuiaba,
America/Curacao,
America/Danmarkshavn,
America/Dawson,
America/Dawson_Creek,
America/Denver,
America/Detroit,
America/Dominica,
America/Edmonton,
America/Eirunepe,
America/El_Salvador,
America/Ensenada,
America/Fort_Nelson,
America/Fort_Wayne,
America/Fortaleza,
America/Glace_Bay,
America/Godthab,
America/Goose_Bay,
America/Grand_Turk,
America/Grenada,
America/Guadeloupe,
America/Guatemala,
America/Guayaquil,
America/Guyana,
America/Halifax,
America/Havana,
America/Hermosillo,
America/Indiana/Indianapolis,
America/Indiana/Knox,
America/Indiana/Marengo,
America/Indiana/Petersburg,
America/Indiana/Tell_City,
America/Indiana/Vevay,
America/Indiana/Vincennes,
America/Indiana/Winamac,
America/Indianapolis,
America/Inuvik,
America/Iqaluit,
America/Jamaica,
America/Jujuy,
America/Juneau,
America/Kentucky/Louisville,
America/Kentucky/Monticello,
America/Knox_IN,
America/Kralendijk,
America/La_Paz,
America/Lima,
America/Los_Angeles,
America/Louisville,
America/Lower_Princes,
America/Maceio,
America/Managua,
America/Manaus,
America/Marigot,
America/Martinique,
America/Matamoros,
America/Mazatlan,
America/Mendoza,
America/Menominee,
America/Merida,
America/Metlakatla,
America/Mexico_City,
America/Miquelon,
America/Moncton,
America/Monterrey,
America/Montevideo,
America/Montreal,
America/Montserrat,
America/Nassau,
America/New_York,
America/Nipigon,
America/Nome,
America/Noronha,
America/North_Dakota/Beulah,
America/North_Dakota/Center,
America/North_Dakota/New_Salem,
America/Nuuk,
America/Ojinaga,
America/Panama,
America/Pangnirtung,
America/Paramaribo,
America/Phoenix,
America/Port-au-Prince,
America/Port_of_Spain,
America/Porto_Acre,
America/Porto_Velho,
America/Puerto_Rico,
America/Punta_Arenas,
America/Rainy_River,
America/Rankin_Inlet,
America/Recife,
America/Regina,
America/Resolute,
America/Rio_Branco,
America/Rosario,
America/Santa_Isabel,
America/Santarem,
America/Santiago,
America/Santo_Domingo,
America/Sao_Paulo,
America/Scoresbysund,
America/Shiprock,
America/Sitka,
America/St_Barthelemy,
America/St_Johns,
America/St_Kitts,
America/St_Lucia,
America/St_Thomas,
America/St_Vincent,
America/Swift_Current,
America/Tegucigalpa,
America/Thule,
America/Thunder_Bay,
America/Tijuana,
America/Toronto,
America/Tortola,
America/Vancouver,
America/Virgin,
America/Whitehorse,
America/Winnipeg,
America/Yakutat,
America/Yellowknife,
Antarctica/Casey,
Antarctica/Davis,
Antarctica/DumontDUrville,
Antarctica/Macquarie,
Antarctica/Mawson,
Antarctica/McMurdo,
Antarctica/Palmer,
Antarctica/Rothera,
Antarctica/South_Pole,
Antarctica/Syowa,
Antarctica/Troll,
Antarctica/Vostok,
Arctic/Longyearbyen,
Asia/Aden,
Asia/Almaty,
Asia/Amman,
Asia/Anadyr,
Asia/Aqtau,
Asia/Aqtobe,
Asia/Ashgabat,
Asia/Ashkhabad,
Asia/Atyrau,
Asia/Baghdad,
Asia/Bahrain,
Asia/Baku,
Asia/Bangkok,
Asia/Barnaul,
Asia/Beirut,
Asia/Bishkek,
Asia/Brunei,
Asia/Calcutta,
Asia/Chita,
Asia/Choibalsan,
Asia/Chongqing,
Asia/Chungking,
Asia/Colombo,
Asia/Dacca,
Asia/Damascus,
Asia/Dhaka,
Asia/Dili,
Asia/Dubai,
Asia/Dushanbe,
Asia/Famagusta,
Asia/Gaza,
Asia/Harbin,
Asia/Hebron,
Asia/Ho_Chi_Minh,
Asia/Hong_Kong,
Asia/Hovd,
Asia/Irkutsk,
Asia/Istanbul,
Asia/Jakarta,
Asia/Jayapura,
Asia/Jerusalem,
Asia/Kabul,
Asia/Kamchatka,
Asia/Karachi,
Asia/Kashgar,
Asia/Kathmandu,
Asia/Katmandu,
Asia/Khandyga,
Asia/Kolkata,
Asia/Krasnoyarsk,
Asia/Kuala_Lumpur,
Asia/Kuching,
Asia/Kuwait,
Asia/Macao,
Asia/Macau,
Asia/Magadan,
Asia/Makassar,
Asia/Manila,
Asia/Muscat,
Asia/Nicosia,
Asia/Novokuznetsk,
Asia/Novosibirsk,
Asia/Omsk,
Asia/Oral,
Asia/Phnom_Penh,
Asia/Pontianak,
Asia/Pyongyang,
Asia/Qatar,
Asia/Qostanay,
Asia/Qyzylorda,
Asia/Rangoon,
Asia/Riyadh,
Asia/Saigon,
Asia/Sakhalin,
Asia/Samarkand,
Asia/Seoul,
Asia/Shanghai,
Asia/Singapore,
Asia/Srednekolymsk,
Asia/Taipei,
Asia/Tashkent,
Asia/Tbilisi,
Asia/Tehran,
Asia/Tel_Aviv,
Asia/Thimbu,
Asia/Thimphu,
Asia/Tokyo,
Asia/Tomsk,
Asia/Ujung_Pandang,
Asia/Ulaanbaatar,
Asia/Ulan_Bator,
Asia/Urumqi,
Asia/Ust-Nera,
Asia/Vientiane,
Asia/Vladivostok,
Asia/Yakutsk,
Asia/Yangon,
Asia/Yekaterinburg,
Asia/Yerevan,
Atlantic/Azores,
Atlantic/Bermuda,
Atlantic/Canary,
Atlantic/Cape_Verde,
Atlantic/Faeroe,
Atlantic/Faroe,
Atlantic/Jan_Mayen,
Atlantic/Madeira,
Atlantic/Reykjavik,
Atlantic/South_Georgia,
Atlantic/St_Helena,
Atlantic/Stanley,
Australia/ACT,
Australia/Adelaide,
Australia/Brisbane,
Australia/Broken_Hill,
Australia/Canberra,
Australia/Currie,
Australia/Darwin,
Australia/Eucla,
Australia/Hobart,
Australia/LHI,
Australia/Lindeman,
Australia/Lord_Howe,
Australia/Melbourne,
Australia/NSW,
Australia/North,
Australia/Perth,
Australia/Queensland,
Australia/South,
Australia/Sydney,
Australia/Tasmania,
Australia/Victoria,
Australia/West,
Australia/Yancowinna,
Brazil/Acre,
Brazil/DeNoronha,
Brazil/East,
Brazil/West,
CET,
CST6CDT,
Canada/Atlantic,
Canada/Central,
Canada/Eastern,
Canada/Mountain,
Canada/Newfoundland,
Canada/Pacific,
Canada/Saskatchewan,
Canada/Yukon,
Chile/Continental,
Chile/EasterIsland,
Cuba,
EET,
EST,
EST5EDT,
Egypt,
Eire,
Etc/GMT,
Etc/GMT+0,
Etc/GMT+1,
Etc/GMT+10,
Etc/GMT+11,
Etc/GMT+12,
Etc/GMT+2,
Etc/GMT+3,
Etc/GMT+4,
Etc/GMT+5,
Etc/GMT+6,
Etc/GMT+7,
Etc/GMT+8,
Etc/GMT+9,
Etc/GMT-0,
Etc/GMT-1,
Etc/GMT-10,
Etc/GMT-11,
Etc/GMT-12,
Etc/GMT-13,
Etc/GMT-14,
Etc/GMT-2,
Etc/GMT-3,
Etc/GMT-4,
Etc/GMT-5,
Etc/GMT-6,
Etc/GMT-7,
Etc/GMT-8,
Etc/GMT-9,
Etc/GMT0,
Etc/Greenwich,
Etc/UCT,
Etc/UTC,
Etc/Universal,
Etc/Zulu,
Europe/Amsterdam,
Europe/Andorra,
Europe/Astrakhan,
Europe/Athens,
Europe/Belfast,
Europe/Belgrade,
Europe/Berlin,
Europe/Bratislava,
Europe/Brussels,
Europe/Bucharest,
Europe/Budapest,
Europe/Busingen,
Europe/Chisinau,
Europe/Copenhagen,
Europe/Dublin,
Europe/Gibraltar,
Europe/Guernsey,
Europe/Helsinki,
Europe/Isle_of_Man,
Europe/Istanbul,
Europe/Jersey,
Europe/Kaliningrad,
Europe/Kiev,
Europe/Kirov,
Europe/Kyiv,
Europe/Lisbon,
Europe/Ljubljana,
Europe/London,
Europe/Luxembourg,
Europe/Madrid,
Europe/Malta,
Europe/Mariehamn,
Europe/Minsk,
Europe/Monaco,
Europe/Moscow,
Europe/Nicosia,
Europe/Oslo,
Europe/Paris,
Europe/Podgorica,
Europe/Prague,
Europe/Riga,
Europe/Rome,
Europe/Samara,
Europe/San_Marino,
Europe/Sarajevo,
Europe/Saratov,
Europe/Simferopol,
Europe/Skopje,
Europe/Sofia,
Europe/Stockholm,
Europe/Tallinn,
Europe/Tirane,
Europe/Tiraspol,
Europe/Ulyanovsk,
Europe/Uzhgorod,
Europe/Vaduz,
Europe/Vatican,
Europe/Vienna,
Europe/Vilnius,
Europe/Volgograd,
Europe/Warsaw,
Europe/Zagreb,
Europe/Zaporozhye,
Europe/Zurich,
Factory,
GB,
GB-Eire,
GMT,
GMT+0,
GMT-0,
GMT0,
Greenwich,
HST,
Hongkong,
Iceland,
Indian/Antananarivo,
Indian/Chagos,
Indian/Christmas,
Indian/Cocos,
Indian/Comoro,
Indian/Kerguelen,
Indian/Mahe,
Indian/Maldives,
Indian/Mauritius,
Indian/Mayotte,
Indian/Reunion,
Iran,
Israel,
Jamaica,
Japan,
Kwajalein,
Libya,
MET,
MST,
MST7MDT,
Mexico/BajaNorte,
Mexico/BajaSur,
Mexico/General,
NZ,
NZ-CHAT,
Navajo,
PRC,
PST8PDT,
Pacific/Apia,
Pacific/Auckland,
Pacific/Bougainville,
Pacific/Chatham,
Pacific/Chuuk,
Pacific/Easter,
Pacific/Efate,
Pacific/Enderbury,
Pacific/Fakaofo,
Pacific/Fiji,
Pacific/Funafuti,
Pacific/Galapagos,
Pacific/Gambier,
Pacific/Guadalcanal,
Pacific/Guam,
Pacific/Honolulu,
Pacific/Johnston,
Pacific/Kanton,
Pacific/Kiritimati,
Pacific/Kosrae,
Pacific/Kwajalein,
Pacific/Majuro,
Pacific/Marquesas,
Pacific/Midway,
Pacific/Nauru,
Pacific/Niue,
Pacific/Norfolk,
Pacific/Noumea,
Pacific/Pago_Pago,
Pacific/Palau,
Pacific/Pitcairn,
Pacific/Pohnpei,
Pacific/Ponape,
Pacific/Port_Moresby,
Pacific/Rarotonga,
Pacific/Saipan,
Pacific/Samoa,
Pacific/Tahiti,
Pacific/Tarawa,
Pacific/Tongatapu,
Pacific/Truk,
Pacific/Wake,
Pacific/Wallis,
Pacific/Yap,
Poland,
Portugal,
ROC,
ROK,
Singapore,
Turkey,
UCT,
US/Alaska,
US/Aleutian,
US/Arizona,
US/Central,
US/East-Indiana,
US/Eastern,
US/Hawaii,
US/Indiana-Starke,
US/Michigan,
US/Mountain,
US/Pacific,
US/Samoa,
UTC,
Universal,
W-SU,
WET,
Zulu,
localtime
tag_ids
string[] | null

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

include_empty
boolean
default:true

Controls which ledgers appear in the report based on activity:

  • true: Includes all ledgers, whether they have line entries or not.

  • false: Only includes ledgers that have at least one line entry. This excludes completely unused ledgers but still includes ledgers with zero balances that aren't empty. Parent ledgers with no direct line entries but active children will be returned.

Response

Successful Response

periods
string[]
required

A list of periods in the range.

Examples:
["Q1-2020", "Q2-2020"]
records
ReportPeriodsRecord · object[]
required

A list of Records that represents either a ledger, a groups of ledgers, or a profit metric.

Records that are groups of ledgers are grouped by income statement sub_type: operating_revenues, cost_of_goods_sold, operating_expenses, other_expenses and other_income. Records that are profit metrics calculate total net sales, gross profit, total operating profit, and net profit.

The list of Records will always be returned in the following order:

  • Operating revenue ledgers (group)
  • Total net sales (calculation)
  • Cost of goods sold (group)
  • Gross profit (calculation)
  • Operating expenses (group)
  • Total operating profit (calculation)
  • Other expenses (group)
  • Other income (group)
  • Net profit (calculation)

Within each sub_type group, Ledger objects are ordered by sort_code.

Examples:
[
{
"amounts": [0, 0],
"children": [
{
"amounts": [262469.88, 272321.32],
"debit_credit": "credit",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"name": "Sales Revenue",
"sort_code": "4100",
"sub_type": "operating_revenues",
"total_amounts": [262469.88, 272321.32],
"type": "revenue"
}
],
"debit_credit": "credit",
"name": "Operating Revenues",
"total_amounts": [262469.88, 272321.32],
"type": "revenue"
},
{
"amounts": [262469.88, 272321.32],
"debit_credit": "credit",
"name": "Total Net Sales",
"total_amounts": [262469.88, 272321.32]
},
{
"amounts": [0, 0],
"children": [
{
"amounts": [134929.69, 144421.61],
"debit_credit": "debit",
"ledger_id": "HLn8oy2eqMUCwjp1Cwdgco",
"name": "Cost Of Goods Sold",
"sort_code": "5100",
"sub_type": "cost_of_goods_sold",
"total_amounts": [134929.69, 144421.61],
"type": "expense"
}
],
"debit_credit": "debit",
"name": "Cost Of Goods Sold",
"total_amounts": [134929.69, 144421.61],
"type": "expense"
},
{
"amounts": [127540.19, 127899.71],
"debit_credit": "credit",
"name": "Gross Profit",
"total_amounts": [127540.19, 127899.71]
},
{
"amounts": [0, 0],
"children": [
{
"amounts": [86276.92, 87271.31],
"debit_credit": "debit",
"ledger_id": "WhvrC7XAES1fDrpWWgmPtg",
"name": "Salaries And Wages Expense",
"sort_code": "5300",
"sub_type": "operating_expenses",
"total_amounts": [86276.92, 87271.31],
"type": "expense"
}
],
"debit_credit": "debit",
"name": "Operating Expenses",
"total_amounts": [86276.92, 87271.31],
"type": "expense"
},
{
"amounts": [41263.27, 40628.4],
"debit_credit": "credit",
"name": "Total Operating Profit",
"total_amounts": [41263.27, 40628.4]
},
{
"amounts": [0, 0],
"debit_credit": "debit",
"name": "Other Expenses",
"total_amounts": [0, 0],
"type": "expense"
},
{
"amounts": [0, 0],
"debit_credit": "credit",
"name": "Other Income",
"total_amounts": [0, 0],
"type": "revenue"
},
{
"amounts": [41263.27, 40628.4],
"debit_credit": "credit",
"name": "Net Profit",
"total_amounts": [41263.27, 40628.4]
}
]