API reference / Account
Get the numbers of the company
The company of the key's workspace and the numbers of each of its workspaces in a period: the revenue, the refunds and the profit by currency, the MRR, the paying customers, the customers at risk, the open disputes, its plan at Troopy and its troop. The total is in the currency of the company. Days are UTC. Without from and to, the period is this month. A key reads only its own company. Needs an owner or admin.
/api/v1/company/overviewOther ways to call it
troopy company overviewtroopy_get_company_overviewQuery parameters
fromstringThe first day of the period, UTC
date
tostringThe last day of the period, UTC. The period includes this day
date
Response
200 · application/jsondata*object8 properties
id*stringA 24-character id
name*stringlegal*object8 properties
legalName*string | nullThe registered name of the company
entityType*string | nullThe legal form, like BV, GmbH, Ltd or LLC
registrationNumber*string | nullThe number in the register of companies
address*string | nullThe registered address
country*string | nullThe country of the company, ISO 3166-1 alpha-2, like NL
currency*string | nullThe currency of the books of the company, ISO 4217, like EUR. Its totals are in it
taxIds*array<object>The tax ids of the company, like VAT or EIN, 5 at most. Data of the business, not a secret
At most 5 items
2 properties
label*stringAt least 1 characters · At most 40 characters
value*stringAt least 1 characters · At most 60 characters
fiscalYearStart*integerThe month that the fiscal year starts in: 1 is January
At least 1 · At most 12
from*stringThe start of the period, included
to*stringThe end of the period, not included
workspaces*array<object>14 properties
id*stringA 24-character id
name*stringrevenue*array<object>The payments of the period, by currency. The same sum as the revenue of Analytics for the same window
2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
refunds*array<object>What went back to payers in the period, by currency. Revenue does not take it off
2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
profit*array<object>The revenue less the refunds, by currency. Troopy knows no costs, so it takes off nothing else
2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
mrr*object | nullThe MRR on the last day of the period that Troopy has, or null with no payment provider
2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
subscribers*integerThe subscribers on that day
payingCustomers*integerThe customers who pay now: active, past due or about to cancel
atRisk*integerThe customers at risk now
openDisputes*objectThe disputes that wait for an answer now
2 properties
count*integeramounts*array<object>2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
plan*objectIts plan at Troopy
2 properties
state*enum<string>trialactivepast_dueendednone
plan*enum<string> | nullpromaxultra
teammates*integerworking*integerThe runs of teammates that go on now, or wait their turn
lastActiveAt*string | nullWhen a teammate of the workspace last worked
total*object | nullEvery workspace in the currency of the company. Null when the company has no currency, or the ECB gives no rate for one of the currencies
7 properties
currency*stringrevenue*integerrefunds*integerprofit*integerThe revenue less the refunds
mrr*integerdisputes*integerThe amount of the open disputes
converted*booleanSome amounts came from another currency, at the rate of the ECB of rateDay
rateDay*string | nullThe day of the rates of the ECB that converted the amounts (YYYY-MM-DD), or null when nothing converted