Moneybird API

Reports

Endpoint:https://moneybird.com/api/v2

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

https://moneybird.com/api/v2

/{administration_id}/reports/assets{format}

Get the assets report for the administration.

Required scope(s)

documents

Assets report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Assets report › query Parameters

periodstring · 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

Assets report › Responses

An assets report

asset_idstring | integer · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
namestring
purchase_datestring · date
lifespanstring | null
In seconds
purchase_valuestring
residual_valuestring
total_value_changes_since_purchasestring
value_at_beginstring
investmentstring
depreciationstring
divestmentstring
value_changesstring
value_at_endstring

Balance sheet report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/balance_sheet{format}

Get the balance sheet report for the administration showing the financial position at the end of the specified period.

Required scope(s)

bank

Balance sheet report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Balance sheet report › query Parameters

periodstring · 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

Balance sheet report › Responses

A balance sheet report

debitobject
Debit side of the balance sheet (assets)
creditobject
Credit side of the balance sheet (equity and liabilities)

Cash flow report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/cash_flow{format}

Get the cash flow report for the administration showing cash received and cash paid during the specified period.

Required scope(s)

bank

Cash flow report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Cash flow report › query Parameters

periodstring · 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
financial_account_idstring | integer · pattern: ^\d+$
Filter the cash flow report by a specific financial account
A unique record identifier

Cash flow report › Responses

A cash flow report

cash_received_by_ledger_accountobject
Data grouped by ledger account
cash_paid_by_ledger_accountobject
Data grouped by ledger account
opening_balancestring
closing_balancestring

Expenses by contact report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/expenses_by_contact{format}

Returns a expenses by contact report for the specified administration.

Required scope(s)

documents

Expenses by contact report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Expenses by contact report › query Parameters

periodstring · 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
pageinteger | string
per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$

Expenses by contact report › Responses

Successful response

expenses_by_contactobject[]

Expenses by project report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/expenses_by_project{format}

Returns a expenses by project report for the specified administration.

Required scope(s)

documents

Expenses by project report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Expenses by project report › query Parameters

periodstring · 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
pageinteger | string
per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$

Expenses by project report › Responses

Successful response

expenses_by_projectobject[]

Export auditfile

POST

https://moneybird.com/api/v2

/{administration_id}/reports/export/auditfile{format}

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

Export auditfile › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Export auditfile › Request Body

yearstring · required
The year for which to generate the auditfile

Export auditfile › Responses

No content

No data returned

Export brugstaat

POST

https://moneybird.com/api/v2

/{administration_id}/reports/export/brugstaat{format}

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

Export brugstaat › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Export brugstaat › Request Body

yearstring · required
The year for which to generate the brugstaat

Export brugstaat › Responses

No content

No data returned

Export ledger accounts

POST

https://moneybird.com/api/v2

/{administration_id}/reports/export/ledger_accounts{format}

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

Export ledger accounts › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Export ledger accounts › Request Body

yearstring · required
The year for which to generate the ledger accounts

Export ledger accounts › Responses

No content

No data returned

General ledger report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/general_ledger{format}

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

General ledger report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

General ledger report › query Parameters

periodstring · 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

General ledger report › Responses

A general ledger report

debit_sumsobject
Data grouped by ledger account
credit_sumsobject
Data grouped by ledger account
start_balanceobject
Data grouped by ledger account
final_balanceobject
Data grouped by ledger account

Journal entries report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/journal_entries{format}

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

Journal entries report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Journal entries report › query Parameters

periodstring · 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
pageinteger | string
per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$
project_idstring
Filter by project ID, use "null" to filter entries without project
contact_idstring
Filter by contact ID, use "null" to filter entries without contact
ledger_account_idstring | integer · pattern: ^\d+$
Filter by ledger account ID
A unique record identifier
account_typestring · enum
Filter by ledger account type
Enum values:
non_current_assets
current_assets
equity
non_current_liabilities
current_liabilities
revenue
direct_costs
expenses

Journal entries report › Responses

A paginated list of journal entries (bookings)

idstring
Unique identifier for the journal entry
administration_idstring | integer · pattern: ^\d+$
ID of the administration this entry belongs to
datestring · date
Date of the journal entry
document_typestring
Type of document this entry relates to
document_idstring | integer · pattern: ^\d+$
ID of the related document
ledger_account_idstring | integer · pattern: ^\d+$
ID of the ledger account
project_idstring | integer | null · pattern: ^\d+$
ID of the related project, if any
contact_idstring | integer | null · pattern: ^\d+$
ID of the related contact, if any
tax_rate_idstring | integer | null · pattern: ^\d+$
ID of the applied tax rate, if any
financial_account_idstring | integer | null · pattern: ^\d+$
ID of the financial account, if any
amountstring
Amount of the journal entry in the administration's currency
descriptionstring
Description of the journal entry

deprecated

Ledger account report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/ledger_accounts/{ledger_account_id}{format}

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

Ledger account report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json
ledger_account_idstring | integer · pattern: ^\d+$ · required
The ID of the ledger account to get the report for
A unique record identifier

Ledger account report › query Parameters

periodstring · 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
pageinteger | string
per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$

Ledger account report › Responses

A paginated list of ledger account bookings (journal entries)

idstring
administration_idstring | integer · pattern: ^\d+$
A unique record identifier
datestring · date
document_typestring
document_idstring | integer · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
project_idstring | integer | null · pattern: ^\d+$
A unique record identifier
contact_idstring | integer | null · pattern: ^\d+$
A unique record identifier
tax_rate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
financial_account_idstring | integer | null · pattern: ^\d+$
A unique record identifier
amountstring
descriptionstring

Profit loss report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/profit_loss{format}

Get the profit loss report for the administration.

Required scope(s)

documents and sales_invoices

Profit loss report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Profit loss report › query Parameters

periodstring · 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
project_idstring | integer · pattern: ^\d+$
A unique record identifier

Profit loss report › Responses

A profit loss report

revenue_by_ledger_accountobject
Data grouped by ledger account
direct_costs_by_ledger_accountobject
Data grouped by ledger account
expenses_by_ledger_accountobject
Data grouped by ledger account
other_income_expenses_by_ledger_accountobject
Data grouped by ledger account
gross_profitstring
Gross profit amount
operating_profitstring
Operating profit amount
net_profitstring
Net profit amount
total_expensesstring
Total expenses amount
total_revenuestring
Total revenue amount

Revenue by contact report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/revenue_by_contact{format}

Returns a revenue by contact report for the specified administration.

Required scope(s)

sales_invoices

Revenue by contact report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Revenue by contact report › query Parameters

periodstring · 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
pageinteger | string
per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$

Revenue by contact report › Responses

Successful response

revenue_by_contactobject[]

Revenue by project report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/revenue_by_project{format}

Returns a revenue by project report for the specified administration.

Required scope(s)

sales_invoices

Revenue by project report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Revenue by project report › query Parameters

periodstring · 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
pageinteger | string
per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$

Revenue by project report › Responses

Successful response

revenue_by_projectobject[]

Subscriptions report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/subscriptions{format}

Get the subscriptions report for the administration.

Required scope(s)

sales_invoices

Subscriptions report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Subscriptions report › query Parameters

periodstring · 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

Subscriptions report › Responses

A subscriptions report

monthly_recurring_revenuestring
annual_run_ratestring
churn_ratestring
lifetime_valuestring

Tax report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/tax{format}

Get the tax report for the administration.

Required scope(s)

documents and sales_invoices

Tax report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Tax report › query Parameters

periodstring · 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

Tax report › Responses

A tax report

tax_ratesobject[]

Recurring sales invoices Sales invoices

Moneybird API

Reports

Endpoint:https://moneybird.com/api/v2

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

https://moneybird.com/api/v2

/{administration_id}/reports/assets{format}

Get the assets report for the administration.

Required scope(s)

documents

Assets report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Assets report › query Parameters

periodstring · 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

Assets report › Responses

An assets report

asset_idstring | integer · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
namestring
purchase_datestring · date
lifespanstring | null
In seconds
purchase_valuestring
residual_valuestring
total_value_changes_since_purchasestring
value_at_beginstring
investmentstring
depreciationstring
divestmentstring
value_changesstring
value_at_endstring

Balance sheet report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/balance_sheet{format}

Get the balance sheet report for the administration showing the financial position at the end of the specified period.

Required scope(s)

bank

Balance sheet report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Balance sheet report › query Parameters

periodstring · 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

Balance sheet report › Responses

A balance sheet report

debitobject
Debit side of the balance sheet (assets)
creditobject
Credit side of the balance sheet (equity and liabilities)

Cash flow report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/cash_flow{format}

Get the cash flow report for the administration showing cash received and cash paid during the specified period.

Required scope(s)

bank

Cash flow report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Cash flow report › query Parameters

periodstring · 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
financial_account_idstring | integer · pattern: ^\d+$
Filter the cash flow report by a specific financial account
A unique record identifier

Cash flow report › Responses

A cash flow report

cash_received_by_ledger_accountobject
Data grouped by ledger account
cash_paid_by_ledger_accountobject
Data grouped by ledger account
opening_balancestring
closing_balancestring

Expenses by contact report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/expenses_by_contact{format}

Returns a expenses by contact report for the specified administration.

Required scope(s)

documents

Expenses by contact report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Expenses by contact report › query Parameters

periodstring · 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
pageinteger | string
per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$

Expenses by contact report › Responses

Successful response

expenses_by_contactobject[]

Expenses by project report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/expenses_by_project{format}

Returns a expenses by project report for the specified administration.

Required scope(s)

documents

Expenses by project report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Expenses by project report › query Parameters

periodstring · 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
pageinteger | string
per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$

Expenses by project report › Responses

Successful response

expenses_by_projectobject[]

Export auditfile

POST

https://moneybird.com/api/v2

/{administration_id}/reports/export/auditfile{format}

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

Export auditfile › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Export auditfile › Request Body

yearstring · required
The year for which to generate the auditfile

Export auditfile › Responses

No content

No data returned

Export brugstaat

POST

https://moneybird.com/api/v2

/{administration_id}/reports/export/brugstaat{format}

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

Export brugstaat › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Export brugstaat › Request Body

yearstring · required
The year for which to generate the brugstaat

Export brugstaat › Responses

No content

No data returned

Export ledger accounts

POST

https://moneybird.com/api/v2

/{administration_id}/reports/export/ledger_accounts{format}

The specified year must contain journal entries.

Required scope(s)

documents and sales_invoices

Export ledger accounts › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Export ledger accounts › Request Body

yearstring · required
The year for which to generate the ledger accounts

Export ledger accounts › Responses

No content

No data returned

General ledger report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/general_ledger{format}

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

General ledger report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

General ledger report › query Parameters

periodstring · 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

General ledger report › Responses

A general ledger report

debit_sumsobject
Data grouped by ledger account
credit_sumsobject
Data grouped by ledger account
start_balanceobject
Data grouped by ledger account
final_balanceobject
Data grouped by ledger account

Journal entries report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/journal_entries{format}

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

Journal entries report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Journal entries report › query Parameters

periodstring · 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
pageinteger | string
per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$
project_idstring
Filter by project ID, use "null" to filter entries without project
contact_idstring
Filter by contact ID, use "null" to filter entries without contact
ledger_account_idstring | integer · pattern: ^\d+$
Filter by ledger account ID
A unique record identifier
account_typestring · enum
Filter by ledger account type
Enum values:
non_current_assets
current_assets
equity
non_current_liabilities
current_liabilities
revenue
direct_costs
expenses

Journal entries report › Responses

A paginated list of journal entries (bookings)

idstring
Unique identifier for the journal entry
administration_idstring | integer · pattern: ^\d+$
ID of the administration this entry belongs to
datestring · date
Date of the journal entry
document_typestring
Type of document this entry relates to
document_idstring | integer · pattern: ^\d+$
ID of the related document
ledger_account_idstring | integer · pattern: ^\d+$
ID of the ledger account
project_idstring | integer | null · pattern: ^\d+$
ID of the related project, if any
contact_idstring | integer | null · pattern: ^\d+$
ID of the related contact, if any
tax_rate_idstring | integer | null · pattern: ^\d+$
ID of the applied tax rate, if any
financial_account_idstring | integer | null · pattern: ^\d+$
ID of the financial account, if any
amountstring
Amount of the journal entry in the administration's currency
descriptionstring
Description of the journal entry

deprecated

Ledger account report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/ledger_accounts/{ledger_account_id}{format}

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

Ledger account report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json
ledger_account_idstring | integer · pattern: ^\d+$ · required
The ID of the ledger account to get the report for
A unique record identifier

Ledger account report › query Parameters

periodstring · 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
pageinteger | string
per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$

Ledger account report › Responses

A paginated list of ledger account bookings (journal entries)

idstring
administration_idstring | integer · pattern: ^\d+$
A unique record identifier
datestring · date
document_typestring
document_idstring | integer · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
project_idstring | integer | null · pattern: ^\d+$
A unique record identifier
contact_idstring | integer | null · pattern: ^\d+$
A unique record identifier
tax_rate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
financial_account_idstring | integer | null · pattern: ^\d+$
A unique record identifier
amountstring
descriptionstring

Profit loss report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/profit_loss{format}

Get the profit loss report for the administration.

Required scope(s)

documents and sales_invoices

Profit loss report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Profit loss report › query Parameters

periodstring · 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
project_idstring | integer · pattern: ^\d+$
A unique record identifier

Profit loss report › Responses

A profit loss report

revenue_by_ledger_accountobject
Data grouped by ledger account
direct_costs_by_ledger_accountobject
Data grouped by ledger account
expenses_by_ledger_accountobject
Data grouped by ledger account
other_income_expenses_by_ledger_accountobject
Data grouped by ledger account
gross_profitstring
Gross profit amount
operating_profitstring
Operating profit amount
net_profitstring
Net profit amount
total_expensesstring
Total expenses amount
total_revenuestring
Total revenue amount

Revenue by contact report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/revenue_by_contact{format}

Returns a revenue by contact report for the specified administration.

Required scope(s)

sales_invoices

Revenue by contact report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Revenue by contact report › query Parameters

periodstring · 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
pageinteger | string
per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$

Revenue by contact report › Responses

Successful response

revenue_by_contactobject[]

Revenue by project report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/revenue_by_project{format}

Returns a revenue by project report for the specified administration.

Required scope(s)

sales_invoices

Revenue by project report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Revenue by project report › query Parameters

periodstring · 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
pageinteger | string
per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$

Revenue by project report › Responses

Successful response

revenue_by_projectobject[]

Subscriptions report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/subscriptions{format}

Get the subscriptions report for the administration.

Required scope(s)

sales_invoices

Subscriptions report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Subscriptions report › query Parameters

periodstring · 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

Subscriptions report › Responses

A subscriptions report

monthly_recurring_revenuestring
annual_run_ratestring
churn_ratestring
lifetime_valuestring

Tax report

GET

https://moneybird.com/api/v2

/{administration_id}/reports/tax{format}

Get the tax report for the administration.

Required scope(s)

documents and sales_invoices

Tax report › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Tax report › query Parameters

periodstring · 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

Tax report › Responses

A tax report

tax_ratesobject[]

Recurring sales invoices Sales invoices