Reports
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
Maximum period: 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_valuecalculated_purchase_valueresidual_valuetotal_value_changes_since_purchasevalue_at_begininvestmentdepreciationdivestmentvalue_changesvalue_at_endvalue_not_in_useAmount booked on an asset whose purchase date is after the end of the period
Balance sheet report
Get the balance sheet report for the administration showing the financial position at the end of the specified period.
With granularity, periods also gives the balance sheet at the end of every month, quarter or year in the 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
Maximum period: 12 months.
granularitySplits the report into periods of a month, a quarter or a year. The response then also contains periods, with the same fields for each period. The first and the last period are cut off at the start and the end of period.
Balance sheet report › Responses
A balance sheet report
Debit side of the balance sheet (assets)
Credit side of the balance sheet (equity and liabilities)
Only present when granularity is given. One item for each month, quarter or year in period, oldest first.
Bank balance report
Get the booked balance of each financial account at the end of the specified period. These are the balances in the bookkeeping, not the balances the bank reports.
With granularity, periods also gives the balances at the end of every month, quarter or year in the 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
Maximum period: 12 months.
granularitySplits the report into periods of a month, a quarter or a year. The response then also contains periods, with the same fields for each period. The first and the last period are cut off at the start and the end of period.
Bank balance report › Responses
A bank balance report
totalThe total of financial_accounts, the same as closing_balance of the cash flow report
The booked balance of every financial account except private withdrawal accounts. Like the balance sheet, an account with a zero balance in every period is left out.
Only present when granularity is given. One item for each month, quarter or year in period, oldest first.
Cash flow report
Get the cash flow report for the administration showing cash received and cash paid during the specified period.
The fields at the top level always cover the whole period: opening_balance is the balance at its start and closing_balance the balance at its end. With granularity, periods gives the same fields per month, quarter or year. Within a period, a section only lists the ledger accounts with cash received or paid in that 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
Maximum period: 12 months.
granularitySplits the report into periods of a month, a quarter or a year. The response then also contains periods, with the same fields for each period. The first and the last period are cut off at the start and the end of period.
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. Contains an array of ledger account entries with ledger_account_id and value.
Data grouped by ledger account. Contains an array of ledger account entries with ledger_account_id and value.
opening_balanceThe balance of the financial accounts at the start of the period
closing_balanceThe balance of the financial accounts at the end of the period
Only present when granularity is given. One item for each month, quarter or year in period, oldest first.
Creditors report
Returns the balance of each creditor at the end of the specified period. The start of the period does not change the result.
With granularity, periods also gives the balance of each creditor at the end of every month, quarter or year in the period.
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
Maximum period: 12 months.
granularitySplits the report into periods of a month, a quarter or a year. The response then also contains periods, with the same fields for each period. The first and the last period are cut off at the start and the end of period.
pageper_page^\d+$Creditors report › Responses
Successful response
Only present when granularity is given. One item for each month, quarter or year in period, oldest first.
Creditors aging report
Returns a creditors aging 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_until^\d{6,8}|this_month|…A period until which a report should be generated.
Date range formats:
YYYYMM(e.g.,202501)
Preset options:
this_month- Current month (default if not specified)prev_month- Previous monththis_quarter- Current quarterprev_quarter- Previous quarterthis_year- Current yearprev_year- Previous year
pageper_page^\d+$Creditors aging report › Responses
Successful response
Debtors report
Returns the balance of each debtor at the end of the specified period. The start of the period does not change the result.
With granularity, periods also gives the balance of each debtor at the end of every month, quarter or year in the period.
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
Maximum period: 12 months.
granularitySplits the report into periods of a month, a quarter or a year. The response then also contains periods, with the same fields for each period. The first and the last period are cut off at the start and the end of period.
pageper_page^\d+$Debtors report › Responses
Successful response
Only present when granularity is given. One item for each month, quarter or year in period, oldest first.
Debtors aging report
Returns a debtors aging 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_until^\d{6,8}|this_month|…A period until which a report should be generated.
Date range formats:
YYYYMM(e.g.,202501)
Preset options:
this_month- Current month (default if not specified)prev_month- Previous monththis_quarter- Current quarterprev_quarter- Previous quarterthis_year- Current yearprev_year- Previous year
pageper_page^\d+$Debtors aging report › Responses
Successful response
Expenses by contact report
Returns a expenses by contact report for the specified administration.
With granularity, periods splits the amounts per month, quarter or year. Within a period, only the contacts on this page with bookings in that period are listed.
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
Maximum period: 12 months.
granularitySplits the report into periods of a month, a quarter or a year. The response then also contains periods, with the same fields for each period. The first and the last period are cut off at the start and the end of period.
pageper_page^\d+$Expenses by contact report › Responses
Successful response
Only present when granularity is given. One item for each month, quarter or year in period, oldest first.
Expenses by project report
Returns a expenses by project report for the specified administration.
With granularity, periods splits the amounts per month, quarter or year. Within a period, only the projects on this page with bookings in that period are listed.
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
Maximum period: 12 months.
granularitySplits the report into periods of a month, a quarter or a year. The response then also contains periods, with the same fields for each period. The first and the last period are cut off at the start and the end of period.
pageper_page^\d+$Expenses by project report › Responses
Successful response
Only present when granularity is given. One item for each month, quarter or year in period, oldest first.
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, 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 › Request Body
yearThe year for which to generate the auditfile
versionThe XAF version of the auditfile
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 › Request Body
yearThe year for which to generate the brugstaat
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.
With granularity, periods gives the same report for every month, quarter or year in the period: the debit and credit sums of that period, and the balance at its start and end. Within a period, only the ledger accounts with a balance or bookings are listed. Profit and loss accounts start at zero in every period, so their final_balance in a period is the result of that period alone; balance sheet accounts carry their balance over. The debit and credit sums leave out the bookings of a fiscal year ending, but the start balance of the next period includes them, so a period does not always start at the final_balance of the period before it.
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
Maximum period: 12 months.
granularitySplits the report into periods of a month, a quarter or a year. The response then also contains periods, with the same fields for each period. The first and the last period are cut off at the start and the end of period.
General ledger report › Responses
A general ledger report
Data grouped by ledger account. Contains an array of ledger account entries with ledger_account_id and value.
Data grouped by ledger account. Contains an array of ledger account entries with ledger_account_id and value.
Data grouped by ledger account. Contains an array of ledger account entries with ledger_account_id and value.
Data grouped by ledger account. Contains an array of ledger account entries with ledger_account_id and value.
Only present when granularity is given. One item for each month, quarter or year in period, oldest first.
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
Maximum period: 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
Maximum period: 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.
Every *_by_ledger_account section contains one item per ledger account with bookings in the period. Nested accounts are flat here: a parent's amount does not include its child accounts, which are listed as items of their own. Adding up all items in a section therefore gives that section's total without double counting.
The sections are not all signed the same way:
| Section | Sign |
|---|---|
| revenue_by_ledger_account | credit minus debit, so revenue is positive |
| direct_costs_by_ledger_account | debit minus credit, so costs are positive |
| expenses_by_ledger_account | debit minus credit, so costs are positive |
| other_income_expenses_by_ledger_account | credit minus debit, so income is positive and expenses are negative |
Sections can therefore not be added together as they are, and adding the three cost sections does not produce total_expenses. The description of each total says how that total is composed.
The fields at the top level always cover the whole period. With granularity, periods splits the same fields per month, quarter or year. Within a period, a section only lists the ledger accounts with bookings in that period.
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
Maximum period: 12 months.
granularitySplits the report into periods of a month, a quarter or a year. The response then also contains periods, with the same fields for each period. The first and the last period are cut off at the start and the end of period.
project_id^\d+$A unique record identifier
Profit loss report › Responses
A profit loss report
Data grouped by ledger account. Contains an array of ledger account entries with ledger_account_id and value.
Data grouped by ledger account. Contains an array of ledger account entries with ledger_account_id and value.
Data grouped by ledger account. Contains an array of ledger account entries with ledger_account_id and value.
Data grouped by ledger account. Contains an array of ledger account entries with ledger_account_id and value.
gross_profittotal_revenue minus the total of direct_costs_by_ledger_account
operating_profitgross_profit minus the total of expenses_by_ledger_account, so excluding other income and expenses
net_profittotal_revenue minus total_expenses
total_expensesThe total of direct_costs_by_ledger_account plus expenses_by_ledger_account minus other_income_expenses_by_ledger_account
total_revenueThe total of revenue_by_ledger_account
Only present when granularity is given. One item for each month, quarter or year in period, oldest first.
Revenue by contact report
Returns a revenue by contact report for the specified administration.
With granularity, periods splits the amounts per month, quarter or year. Within a period, only the contacts on this page with bookings in that period are listed.
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
Maximum period: 12 months.
granularitySplits the report into periods of a month, a quarter or a year. The response then also contains periods, with the same fields for each period. The first and the last period are cut off at the start and the end of period.
pageper_page^\d+$Revenue by contact report › Responses
Successful response
Only present when granularity is given. One item for each month, quarter or year in period, oldest first.
Revenue by project report
Returns a revenue by project report for the specified administration.
With granularity, periods splits the amounts per month, quarter or year. Within a period, only the projects on this page with bookings in that period are listed.
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
Maximum period: 12 months.
granularitySplits the report into periods of a month, a quarter or a year. The response then also contains periods, with the same fields for each period. The first and the last period are cut off at the start and the end of period.
pageper_page^\d+$Revenue by project report › Responses
Successful response
Only present when granularity is given. One item for each month, quarter or year in period, oldest first.
Subscriptions report
Get the subscriptions report for the administration. All values are for the last month of the specified period. For example, this_year returns the values for December.
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
Maximum period: 12 months.
Subscriptions report › Responses
A subscriptions report
monthly_recurring_revenueannual_run_ratechurn_ratelifetime_valueTax report
Get the tax report for the administration.
tax_rates at the top level always covers the whole period. With granularity, periods gives the same list per month, quarter or year. Within a period, only the tax rates with a non-zero amount in that period are listed.
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
Maximum period: 12 months.
granularitySplits the report into periods of a month, a quarter or a year. The response then also contains periods, with the same fields for each period. The first and the last period are cut off at the start and the end of period.
Tax report › Responses
A tax report
Only present when granularity is given. One item for each month, quarter or year in period, oldest first.
Working capital report
Get the working capital of the administration at the end of the specified period, with the same figures as the balance card on the reports page.
With granularity, periods also gives the working capital at the end of every month, quarter or year in the 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
Maximum period: 12 months.
granularitySplits the report into periods of a month, a quarter or a year. The response then also contains periods, with the same fields for each period. The first and the last period are cut off at the start and the end of period.
Working capital report › Responses
A working capital report
working_capitalCurrent assets minus current liabilities
bankThe balance of the financial accounts, or zero when that balance is negative
to_receiveThe current assets other than bank
to_payThe current liabilities, including a negative balance of the financial accounts
Only present when granularity is given. One item for each month, quarter or year in period, oldest first.