API reference / Account
Get the report of the company for its accountant
The revenue, the refunds and the disputes of the company of the key's workspace in one fiscal year, for each month, workspace and currency. A dispute counts in the month that it opened, with its status now. Each amount is in the currency that the customer paid, and in the currency of the company at the ECB rate of its day. A weekend or a holiday takes the rate of the day before it. The report holds no costs, payroll, bank balances, tax or fees. A key reads only its own company. Needs an owner or admin.
/api/v1/company/reportOther ways to call it
troopy company reporttroopy_get_company_reportQuery parameters
yearintegerThe calendar year in which the fiscal year starts. Without it, the fiscal year of today
At least 2000 · At most 2100
Response
200 · application/jsondata*object11 properties
company*object3 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
year*integerThe calendar year in which the fiscal year starts
name*stringThe name of the fiscal year: "2026", or "2026/27" when it does not start in January
from*stringThe start of the fiscal year, included
to*stringThe end of the fiscal year, not included
currency*string | nullThe currency of the company, or null before someone gives it
months*array<object>Each month of the company
4 properties
revenue*object2 properties
paid*array<object>By the currency that the customers paid
2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
converted*integer | nullIn the currency of the company. Null when a rate is missing, or the company has no currency
refunds*object2 properties
paid*array<object>By the currency that the customers paid
2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
converted*integer | nullIn the currency of the company. Null when a rate is missing, or the company has no currency
disputes*object2 properties
paid*array<object>By the currency that the customers paid
2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
converted*integer | nullIn the currency of the company. Null when a rate is missing, or the company has no currency
month*stringYYYY-MM, UTC
total*objectThe year of the company
3 properties
revenue*object2 properties
paid*array<object>By the currency that the customers paid
2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
converted*integer | nullIn the currency of the company. Null when a rate is missing, or the company has no currency
refunds*object2 properties
paid*array<object>By the currency that the customers paid
2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
converted*integer | nullIn the currency of the company. Null when a rate is missing, or the company has no currency
disputes*object2 properties
paid*array<object>By the currency that the customers paid
2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
converted*integer | nullIn the currency of the company. Null when a rate is missing, or the company has no currency
workspaces*array<object>5 properties
id*stringA 24-character id
name*stringrecorded*objectThe revenue and the refunds of the year in the currency that Analytics keeps them in: the same sums as the overview
2 properties
revenue*array<object>2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
refunds*array<object>2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
months*array<object>4 properties
revenue*object2 properties
paid*array<object>By the currency that the customers paid
2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
converted*integer | nullIn the currency of the company. Null when a rate is missing, or the company has no currency
refunds*object2 properties
paid*array<object>By the currency that the customers paid
2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
converted*integer | nullIn the currency of the company. Null when a rate is missing, or the company has no currency
disputes*object2 properties
paid*array<object>By the currency that the customers paid
2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
converted*integer | nullIn the currency of the company. Null when a rate is missing, or the company has no currency
month*stringYYYY-MM, UTC
total*object3 properties
revenue*object2 properties
paid*array<object>By the currency that the customers paid
2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
converted*integer | nullIn the currency of the company. Null when a rate is missing, or the company has no currency
refunds*object2 properties
paid*array<object>By the currency that the customers paid
2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
converted*integer | nullIn the currency of the company. Null when a rate is missing, or the company has no currency
disputes*object2 properties
paid*array<object>By the currency that the customers paid
2 properties
currency*stringISO 4217, upper case, like EUR
amount*integerIn minor units (cents)
converted*integer | nullIn the currency of the company. Null when a rate is missing, or the company has no currency
lines*array<object>One line for each month, workspace, kind, currency and status of a dispute
10 properties
month*stringYYYY-MM, UTC
workspaceId*stringA 24-character id
kind*enum<string>A dispute counts in the month that it opened
revenuerefunddispute
status*string | nullThe status of the disputes now, in the words of the provider, like won or lost. Null for revenue and refunds
currency*stringThe currency that the customers paid
amount*integerIn minor units of currency
count*integerThe payments, refunds or disputes
converted*integer | nullIn minor units of the currency of the company, at the ECB rate of the day of each amount
rate*number | nullOne unit of currency in the currency of the company: the ECB rates of the days of the month, by amount
rateDays*object | nullThe first and the last day of those ECB rates (YYYY-MM-DD). A weekend takes the rate of the day before it
2 properties
from*stringto*stringgaps*array<string>Why some converted amounts are empty