Moneybird logo
Moneybird API
Moneybird API

Downloads

Downloads are files that have been generated as exports from your administration. These can be CSV exports of contacts, sales invoices, time entries, or various financial reports. Use these endpoints to retrieve a list of available downloads and to download the files.

Download a file

POST
https://moneybird.com/api/v2
/{administration_id}/downloads/{id}/download{format}

Returns a redirect to the actual file download URL. The required permission scope depends on the download's type (for example export_documents requires documents, export_sales_invoices requires sales_invoices, export_contacts requires contacts, and report exports require the same permissions as the corresponding report). The token must have the permission matching the download type. The response is a 302 redirect. The client should follow the Location header to download the actual file. The link is valid for 30 seconds.

Download a file › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json
id
​identifier · pattern: ^\d+$ · required

The download ID

A unique record identifier

Download a file › Responses

Found

string

List all downloads

GET
https://moneybird.com/api/v2
/{administration_id}/downloads{format}

Returns a paginated list of all downloads in the administration.

Only downloads that the authenticated user has permission to access will be returned, based on the download type and the user's permissions within the administration.

List all downloads › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

List all downloads › query Parameters

per_page
​integer | string · min: 1 · max: 100 · pattern: ^\d+$
page
​integer | string
download_type
​string

Filter downloads by type. Common download types include:

  • auditfile
  • brugstaat
  • export_ledger_account_report

Check the download_type field in the response to see all available types.

downloaded
​boolean | string
failed
​boolean | string

List all downloads › Responses

A list of downloads

download_response
id
​identifier · pattern: ^\d+$

A unique record identifier

user_id
​identifier_nullable · pattern: ^\d+$

The user who created the download

download_type
​string

The type of download (e.g., export_contacts, export_sales_invoices, auditfile)

filename
​string
content_type
​string
failed
​boolean
downloaded
​boolean
created_at
​timestamp · date-time
updated_at
​timestamp · date-time
Document stylesDocuments: General documents