Reports provide analytical data about your administration, such as revenue and expense breakdowns by various dimensions like projects, contacts, or time periods. This features is currently still in beta. Please provide feedback by filling in this feedback form.
Assets report
Get the assets report for the administration.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
period
string · pattern:^(\d{6,8}(..\d{6,8})…
The period can be a date range or one of the presets. Date ranges must be one whole month.
Default: this_month
Responses
An assets report
asset_id
string | integer · pattern:^\d+$
A unique record identifier
ledger_account_id
string | integer · pattern:^\d+$
A unique record identifier
name
stringpurchase_date
string · datelifespan
string | nullIn seconds
purchase_value
stringresidual_value
stringtotal_value_changes_since_purchase
stringvalue_at_begin
stringinvestment
stringdepreciation
stringdivestment
stringvalue_changes
stringvalue_at_end
string
Balance sheet report
Get the balance sheet report for the administration showing the financial position at the end of the specified period.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
period
string · pattern:^(\d{6,8}(..\d{6,8})…
The period can be a date range or one of the presets. Date ranges must be one whole month.
Default: this_month
Responses
A balance sheet report
debit
objectDebit side of the balance sheet (assets)
credit
objectCredit side of the balance sheet (equity and liabilities)
Cash flow report
Get the cash flow report for the administration showing cash received and cash paid during the specified period.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
period
string · pattern:^(\d{6,8}(..\d{6,8})…
The period can be a date range or one of the presets. Date ranges must be one whole month.
Default: this_monthfinancial_account_id
string | integer · pattern:^\d+$
Filter the cash flow report by a specific financial account
A unique record identifier
Responses
A cash flow report
cash_received_by_ledger_account
objectData grouped by ledger account
cash_paid_by_ledger_account
objectData grouped by ledger account
opening_balance
stringclosing_balance
string
Expenses by contact report
Returns a expenses by contact report for the specified administration.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
period
string · pattern:^(\d{6,8}(..\d{6,8})…
The period can be a date range or one of the presets. Date ranges must be one whole month.
Default: this_monthpage
integer | stringper_page
integer | string · min: 1 · max: 100 · pattern:^\d+$
Responses
Successful response
expenses_by_contact
object[]
Expenses by project report
Returns a expenses by project report for the specified administration.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
period
string · pattern:^(\d{6,8}(..\d{6,8})…
The period can be a date range or one of the presets. Date ranges must be one whole month.
Default: this_monthpage
integer | stringper_page
integer | string · min: 1 · max: 100 · pattern:^\d+$
Responses
Successful response
expenses_by_project
object[]
Export auditfile
Queue the export of an auditfile (XAF XML format) for the specified year. The auditfile will be added to your downloads when ready.
The administration must not have any ledger accounts with missing or duplicate account IDs, and the specified year must contain journal entries.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
No content
Export brugstaat
Queue the export of a brugstaat XML file for the specified year. The file will be added to your downloads when ready.
All ledger accounts must have valid RGS taxonomy codes assigned.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
No content
Export ledger accounts
Queue the export of ledger accounts (grootboekkaarten) to an Excel file for the specified year. This file contains all bookings and can be used for manual audits. The file will be added to your downloads when ready.
The specified year must contain journal entries.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
No content
General ledger report
Get the general ledger report for the administration showing all ledger accounts with their balances and movements during the specified period.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
period
string · pattern:^(\d{6,8}(..\d{6,8})…
The period can be a date range or one of the presets. Date ranges must be one whole month.
Default: this_month
Responses
A general ledger report
debit_sums
objectData grouped by ledger account
credit_sums
objectData grouped by ledger account
start_balance
objectData grouped by ledger account
final_balance
objectData grouped by ledger account
Journal entries report
Get the journal entries report showing all bookings within the specified period. This endpoint allows filtering by various criteria including project, contact, ledger account, and account types.
Requirements:
- At least one of project_id, contact_id, or ledger_account_id is required
- When account_type is provided, either contact_id or project_id must also be specified
Example Use Cases:
- To get a report for revenue by project detail, use account_type parameter with value "revenue" and the required project_id
- To get a report for revenue by contact detail, use account_type parameter with value "revenue" and the required contact_id
- To get a report for expenses by project detail, make one request for account_type "expenses" and one for "direct_costs", both with the required project_id
- To get a report for expenses by contact detail, make one request for account_type "expenses" and one for "direct_costs", both with the required contact_id
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
period
string · pattern:^(\d{6,8}(..\d{6,8})…
The period can be a date range or one of the presets. Date ranges must be one whole month.
Default: this_monthpage
integer | stringper_page
integer | string · min: 1 · max: 100 · pattern:^\d+$
project_id
stringFilter by project ID, use "null" to filter entries without project
contact_id
stringFilter by contact ID, use "null" to filter entries without contact
ledger_account_id
string | integer · pattern:^\d+$
Filter by ledger account ID
A unique record identifier
account_type
string · enumFilter by ledger account type
Enum values:non_current_assetscurrent_assetsequitynon_current_liabilitiescurrent_liabilitiesrevenuedirect_costsexpenses
Responses
A paginated list of journal entries (bookings)
id
stringUnique identifier for the journal entry
administration_id
string | integer · pattern:^\d+$
ID of the administration this entry belongs to
date
string · dateDate of the journal entry
document_type
stringType of document this entry relates to
document_id
string | integer · pattern:^\d+$
ID of the related document
ledger_account_id
string | integer · pattern:^\d+$
ID of the ledger account
project_id
string | integer | null · pattern:^\d+$
ID of the related project, if any
contact_id
string | integer | null · pattern:^\d+$
ID of the related contact, if any
tax_rate_id
string | integer | null · pattern:^\d+$
ID of the applied tax rate, if any
financial_account_id
string | integer | null · pattern:^\d+$
ID of the financial account, if any
amount
stringAmount of the journal entry in the administration's currency
description
stringDescription of the journal entry
Ledger account report
This endpoint is deprecated and should no longer be used. It has been replaced by the Journal entries report
.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .jsonledger_account_id
string | integer · pattern:^\d+$
· requiredThe ID of the ledger account to get the report for
A unique record identifier
query Parameters
period
string · pattern:^(\d{6,8}(..\d{6,8})…
The period can be a date range or one of the presets. Date ranges must be one whole month.
Default: this_monthpage
integer | stringper_page
integer | string · min: 1 · max: 100 · pattern:^\d+$
Responses
A paginated list of ledger account bookings (journal entries)
id
stringadministration_id
string | integer · pattern:^\d+$
A unique record identifier
date
string · datedocument_type
stringdocument_id
string | integer · pattern:^\d+$
A unique record identifier
ledger_account_id
string | integer · pattern:^\d+$
A unique record identifier
project_id
string | integer | null · pattern:^\d+$
A unique record identifier
contact_id
string | integer | null · pattern:^\d+$
A unique record identifier
tax_rate_id
string | integer | null · pattern:^\d+$
A unique record identifier
financial_account_id
string | integer | null · pattern:^\d+$
A unique record identifier
amount
stringdescription
string
Profit loss report
Get the profit loss report for the administration.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
period
string · pattern:^(\d{6,8}(..\d{6,8})…
The period can be a date range or one of the presets. Date ranges must be one whole month.
Default: this_monthproject_id
string | integer · pattern:^\d+$
A unique record identifier
Responses
A profit loss report
revenue_by_ledger_account
objectData grouped by ledger account
direct_costs_by_ledger_account
objectData grouped by ledger account
expenses_by_ledger_account
objectData grouped by ledger account
other_income_expenses_by_ledger_account
objectData grouped by ledger account
gross_profit
stringGross profit amount
operating_profit
stringOperating profit amount
net_profit
stringNet profit amount
total_expenses
stringTotal expenses amount
total_revenue
stringTotal revenue amount
Revenue by contact report
Returns a revenue by contact report for the specified administration.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
period
string · pattern:^(\d{6,8}(..\d{6,8})…
The period can be a date range or one of the presets. Date ranges must be one whole month.
Default: this_monthpage
integer | stringper_page
integer | string · min: 1 · max: 100 · pattern:^\d+$
Responses
Successful response
revenue_by_contact
object[]
Revenue by project report
Returns a revenue by project report for the specified administration.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
period
string · pattern:^(\d{6,8}(..\d{6,8})…
The period can be a date range or one of the presets. Date ranges must be one whole month.
Default: this_monthpage
integer | stringper_page
integer | string · min: 1 · max: 100 · pattern:^\d+$
Responses
Successful response
revenue_by_project
object[]
Subscriptions report
Get the subscriptions report for the administration.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
period
string · pattern:^(\d{6,8}(..\d{6,8})…
The period can be a date range or one of the presets. Date ranges must be one whole month.
Default: this_month
Responses
A subscriptions report
monthly_recurring_revenue
stringannual_run_rate
stringchurn_rate
stringlifetime_value
string
Tax report
Get the tax report for the administration.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
period
string · pattern:^(\d{6,8}(..\d{6,8})…
The period can be a date range or one of the presets. Date ranges must be one whole month.
Default: this_month
Responses
A tax report
tax_rates
object[]