Reports provide analytical data about your administration, such as revenue and expense breakdowns by various dimensions like projects, contacts, or time periods.
Assets report
Get the assets report for the administration.
Required scope(s)
documents
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
period^\d{6,8}(..\d{6,8})?…The period can be a date range or one of the presets. Date ranges must consist of whole months (start on 1st, end on last day of month).
Date range formats:
YYYYMMDD..YYYYMMDD(e.g.,20250101..20250131)YYYYMM..YYYYMM(e.g.,202501..202501)YYYYMM(e.g.,202501)
Preset options:
this_month- Current month (default if not specified)prev_month- Previous monthnext_month- Next monththis_quarter- Current quarterprev_quarter- Previous quarternext_quarter- Next quarterthis_year- Current yearprev_year- Previous yearnext_year- Next year
Period limits:
- Most endpoints: Maximum 1 month
- Profit loss & balance sheet: Maximum 12 months
Assets report › Responses
An assets report
asset_id^\d+$A unique record identifier
ledger_account_id^\d+$A unique record identifier
namepurchase_datelifespanIn seconds
purchase_valueresidual_valuetotal_value_changes_since_purchasevalue_at_begininvestmentdepreciationdivestmentvalue_changesvalue_at_endBalance sheet report
Get the balance sheet report for the administration showing the financial position at the end of the specified period.
Required scope(s)
bank
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
period^\d{6,8}(..\d{6,8})?…The period can be a date range or one of the presets. Date ranges must consist of whole months (start on 1st, end on last day of month).
Date range formats:
YYYYMMDD..YYYYMMDD(e.g.,20250101..20250131)YYYYMM..YYYYMM(e.g.,202501..202501)YYYYMM(e.g.,202501)
Preset options:
this_month- Current month (default if not specified)prev_month- Previous monthnext_month- Next monththis_quarter- Current quarterprev_quarter- Previous quarternext_quarter- Next quarterthis_year- Current yearprev_year- Previous yearnext_year- Next year
Period limits:
- Most endpoints: Maximum 1 month
- Profit loss & balance sheet: Maximum 12 months
Balance sheet report › Responses
A balance sheet report
Debit side of the balance sheet (assets)
Credit 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.
Required scope(s)
bank
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
period^\d{6,8}(..\d{6,8})?…The period can be a date range or one of the presets. Date ranges must consist of whole months (start on 1st, end on last day of month).
Date range formats:
YYYYMMDD..YYYYMMDD(e.g.,20250101..20250131)YYYYMM..YYYYMM(e.g.,202501..202501)YYYYMM(e.g.,202501)
Preset options:
this_month- Current month (default if not specified)prev_month- Previous monthnext_month- Next monththis_quarter- Current quarterprev_quarter- Previous quarternext_quarter- Next quarterthis_year- Current yearprev_year- Previous yearnext_year- Next year
Period limits:
- Most endpoints: Maximum 1 month
- Profit loss & balance sheet: Maximum 12 months
financial_account_id^\d+$Filter the cash flow report by a specific financial account
A unique record identifier
Cash flow report › Responses
A cash flow report
Data grouped by ledger account
Data grouped by ledger account
opening_balanceclosing_balanceCreditors report
Returns a creditors report for the specified administration.
Required scope(s)
documents
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
period^\d{6,8}(..\d{6,8})?…The period can be a date range or one of the presets. Date ranges must consist of whole months (start on 1st, end on last day of month).
Date range formats:
YYYYMMDD..YYYYMMDD(e.g.,20250101..20250131)YYYYMM..YYYYMM(e.g.,202501..202501)YYYYMM(e.g.,202501)
Preset options:
this_month- Current month (default if not specified)prev_month- Previous monthnext_month- Next monththis_quarter- Current quarterprev_quarter- Previous quarternext_quarter- Next quarterthis_year- Current yearprev_year- Previous yearnext_year- Next year
Period limits:
- Most endpoints: Maximum 1 month
- Profit loss & balance sheet: Maximum 12 months
pageper_page^\d+$Creditors report › Responses
Successful response
Debtors report
Returns a debtors report for the specified administration.
Required scope(s)
documents
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
period^\d{6,8}(..\d{6,8})?…The period can be a date range or one of the presets. Date ranges must consist of whole months (start on 1st, end on last day of month).
Date range formats:
YYYYMMDD..YYYYMMDD(e.g.,20250101..20250131)YYYYMM..YYYYMM(e.g.,202501..202501)YYYYMM(e.g.,202501)
Preset options:
this_month- Current month (default if not specified)prev_month- Previous monthnext_month- Next monththis_quarter- Current quarterprev_quarter- Previous quarternext_quarter- Next quarterthis_year- Current yearprev_year- Previous yearnext_year- Next year
Period limits:
- Most endpoints: Maximum 1 month
- Profit loss & balance sheet: Maximum 12 months
pageper_page^\d+$Debtors report › Responses
Successful response
Expenses by contact report
Returns a expenses by contact report for the specified administration.
Required scope(s)
documents
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
period^\d{6,8}(..\d{6,8})?…The period can be a date range or one of the presets. Date ranges must consist of whole months (start on 1st, end on last day of month).
Date range formats:
YYYYMMDD..YYYYMMDD(e.g.,20250101..20250131)YYYYMM..YYYYMM(e.g.,202501..202501)YYYYMM(e.g.,202501)
Preset options:
this_month- Current month (default if not specified)prev_month- Previous monthnext_month- Next monththis_quarter- Current quarterprev_quarter- Previous quarternext_quarter- Next quarterthis_year- Current yearprev_year- Previous yearnext_year- Next year
Period limits:
- Most endpoints: Maximum 1 month
- Profit loss & balance sheet: Maximum 12 months
pageper_page^\d+$Expenses by contact report › Responses
Successful response
Expenses by project report
Returns a expenses by project report for the specified administration.
Required scope(s)
documents
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
period^\d{6,8}(..\d{6,8})?…The period can be a date range or one of the presets. Date ranges must consist of whole months (start on 1st, end on last day of month).
Date range formats:
YYYYMMDD..YYYYMMDD(e.g.,20250101..20250131)YYYYMM..YYYYMM(e.g.,202501..202501)YYYYMM(e.g.,202501)
Preset options:
this_month- Current month (default if not specified)prev_month- Previous monthnext_month- Next monththis_quarter- Current quarterprev_quarter- Previous quarternext_quarter- Next quarterthis_year- Current yearprev_year- Previous yearnext_year- Next year
Period limits:
- Most endpoints: Maximum 1 month
- Profit loss & balance sheet: Maximum 12 months
pageper_page^\d+$Expenses by project report › Responses
Successful response
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.
Required scope(s)
All of: bank, contacts, documents, estimates, sales_invoices and settings
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Export auditfile › 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.
Required scope(s)
All of: bank, documents and sales_invoices
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Export brugstaat › 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.
Required scope(s)
documents and sales_invoices
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Export ledger accounts › Request Body
yearThe year for which to generate the ledger accounts
Export ledger accounts › 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.
Required scope(s)
bank
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
period^\d{6,8}(..\d{6,8})?…The period can be a date range or one of the presets. Date ranges must consist of whole months (start on 1st, end on last day of month).
Date range formats:
YYYYMMDD..YYYYMMDD(e.g.,20250101..20250131)YYYYMM..YYYYMM(e.g.,202501..202501)YYYYMM(e.g.,202501)
Preset options:
this_month- Current month (default if not specified)prev_month- Previous monthnext_month- Next monththis_quarter- Current quarterprev_quarter- Previous quarternext_quarter- Next quarterthis_year- Current yearprev_year- Previous yearnext_year- Next year
Period limits:
- Most endpoints: Maximum 1 month
- Profit loss & balance sheet: Maximum 12 months
General ledger report › Responses
A general ledger report
Data grouped by ledger account
Data grouped by ledger account
Data grouped by ledger account
Data 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
Required scope(s)
documents and sales_invoices
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
period^\d{6,8}(..\d{6,8})?…The period can be a date range or one of the presets. Date ranges must consist of whole months (start on 1st, end on last day of month).
Date range formats:
YYYYMMDD..YYYYMMDD(e.g.,20250101..20250131)YYYYMM..YYYYMM(e.g.,202501..202501)YYYYMM(e.g.,202501)
Preset options:
this_month- Current month (default if not specified)prev_month- Previous monthnext_month- Next monththis_quarter- Current quarterprev_quarter- Previous quarternext_quarter- Next quarterthis_year- Current yearprev_year- Previous yearnext_year- Next year
Period limits:
- Most endpoints: Maximum 1 month
- Profit loss & balance sheet: Maximum 12 months
pageper_page^\d+$project_idFilter by project ID, use "null" to filter entries without project
contact_idFilter by contact ID, use "null" to filter entries without contact
ledger_account_id^\d+$Filter by ledger account ID
A unique record identifier
account_typeFilter by ledger account type
Journal entries report › Responses
A paginated list of journal entries (bookings)
idUnique identifier for the journal entry
administration_id^\d+$ID of the administration this entry belongs to
dateDate of the journal entry
document_typeType of document this entry relates to
document_id^\d+$ID of the related document
ledger_account_id^\d+$ID of the ledger account
project_id^\d+$ID of the related project, if any
contact_id^\d+$ID of the related contact, if any
tax_rate_id^\d+$ID of the applied tax rate, if any
financial_account_id^\d+$ID of the financial account, if any
amountAmount of the journal entry in the administration's currency
descriptionDescription 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.
Required scope(s)
documents and sales_invoices
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
ledger_account_id^\d+$ · requiredThe ID of the ledger account to get the report for
A unique record identifier
query Parameters
period^\d{6,8}(..\d{6,8})?…The period can be a date range or one of the presets. Date ranges must consist of whole months (start on 1st, end on last day of month).
Date range formats:
YYYYMMDD..YYYYMMDD(e.g.,20250101..20250131)YYYYMM..YYYYMM(e.g.,202501..202501)YYYYMM(e.g.,202501)
Preset options:
this_month- Current month (default if not specified)prev_month- Previous monthnext_month- Next monththis_quarter- Current quarterprev_quarter- Previous quarternext_quarter- Next quarterthis_year- Current yearprev_year- Previous yearnext_year- Next year
Period limits:
- Most endpoints: Maximum 1 month
- Profit loss & balance sheet: Maximum 12 months
pageper_page^\d+$Ledger account report › Responses
A paginated list of ledger account bookings (journal entries)
idadministration_id^\d+$A unique record identifier
datedocument_typedocument_id^\d+$A unique record identifier
ledger_account_id^\d+$A unique record identifier
project_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
tax_rate_id^\d+$A unique record identifier
financial_account_id^\d+$A unique record identifier
amountdescriptionProfit loss report
Get the profit loss report for the administration.
Required scope(s)
documents and sales_invoices
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
period^\d{6,8}(..\d{6,8})?…The period can be a date range or one of the presets. Date ranges must consist of whole months (start on 1st, end on last day of month).
Date range formats:
YYYYMMDD..YYYYMMDD(e.g.,20250101..20250131)YYYYMM..YYYYMM(e.g.,202501..202501)YYYYMM(e.g.,202501)
Preset options:
this_month- Current month (default if not specified)prev_month- Previous monthnext_month- Next monththis_quarter- Current quarterprev_quarter- Previous quarternext_quarter- Next quarterthis_year- Current yearprev_year- Previous yearnext_year- Next year
Period limits:
- Most endpoints: Maximum 1 month
- Profit loss & balance sheet: Maximum 12 months
project_id^\d+$A unique record identifier
Profit loss report › Responses
A profit loss report
Data grouped by ledger account
Data grouped by ledger account
Data grouped by ledger account
Data grouped by ledger account
gross_profitGross profit amount
operating_profitOperating profit amount
net_profitNet profit amount
total_expensesTotal expenses amount
total_revenueTotal revenue amount
Revenue by contact report
Returns a revenue by contact report for the specified administration.
Required scope(s)
sales_invoices
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
period^\d{6,8}(..\d{6,8})?…The period can be a date range or one of the presets. Date ranges must consist of whole months (start on 1st, end on last day of month).
Date range formats:
YYYYMMDD..YYYYMMDD(e.g.,20250101..20250131)YYYYMM..YYYYMM(e.g.,202501..202501)YYYYMM(e.g.,202501)
Preset options:
this_month- Current month (default if not specified)prev_month- Previous monthnext_month- Next monththis_quarter- Current quarterprev_quarter- Previous quarternext_quarter- Next quarterthis_year- Current yearprev_year- Previous yearnext_year- Next year
Period limits:
- Most endpoints: Maximum 1 month
- Profit loss & balance sheet: Maximum 12 months
pageper_page^\d+$Revenue by contact report › Responses
Successful response
Revenue by project report
Returns a revenue by project report for the specified administration.
Required scope(s)
sales_invoices
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
period^\d{6,8}(..\d{6,8})?…The period can be a date range or one of the presets. Date ranges must consist of whole months (start on 1st, end on last day of month).
Date range formats:
YYYYMMDD..YYYYMMDD(e.g.,20250101..20250131)YYYYMM..YYYYMM(e.g.,202501..202501)YYYYMM(e.g.,202501)
Preset options:
this_month- Current month (default if not specified)prev_month- Previous monthnext_month- Next monththis_quarter- Current quarterprev_quarter- Previous quarternext_quarter- Next quarterthis_year- Current yearprev_year- Previous yearnext_year- Next year
Period limits:
- Most endpoints: Maximum 1 month
- Profit loss & balance sheet: Maximum 12 months
pageper_page^\d+$Revenue by project report › Responses
Successful response
Subscriptions report
Get the subscriptions report for the administration.
Required scope(s)
sales_invoices
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
period^\d{6,8}(..\d{6,8})?…The period can be a date range or one of the presets. Date ranges must consist of whole months (start on 1st, end on last day of month).
Date range formats:
YYYYMMDD..YYYYMMDD(e.g.,20250101..20250131)YYYYMM..YYYYMM(e.g.,202501..202501)YYYYMM(e.g.,202501)
Preset options:
this_month- Current month (default if not specified)prev_month- Previous monthnext_month- Next monththis_quarter- Current quarterprev_quarter- Previous quarternext_quarter- Next quarterthis_year- Current yearprev_year- Previous yearnext_year- Next year
Period limits:
- Most endpoints: Maximum 1 month
- Profit loss & balance sheet: Maximum 12 months
Subscriptions report › Responses
A subscriptions report
monthly_recurring_revenueannual_run_ratechurn_ratelifetime_valueTax report
Get the tax report for the administration.
Required scope(s)
documents and sales_invoices
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
period^\d{6,8}(..\d{6,8})?…The period can be a date range or one of the presets. Date ranges must consist of whole months (start on 1st, end on last day of month).
Date range formats:
YYYYMMDD..YYYYMMDD(e.g.,20250101..20250131)YYYYMM..YYYYMM(e.g.,202501..202501)YYYYMM(e.g.,202501)
Preset options:
this_month- Current month (default if not specified)prev_month- Previous monthnext_month- Next monththis_quarter- Current quarterprev_quarter- Previous quarternext_quarter- Next quarterthis_year- Current yearprev_year- Previous yearnext_year- Next year
Period limits:
- Most endpoints: Maximum 1 month
- Profit loss & balance sheet: Maximum 12 months
Tax report › Responses
A tax report