Moneybird integration: operations for AI agents
Moneybird connects to Type.com as an integration. This page lists the 293 operations documented for Claude and Codex in Type.com: 128 read, 110 write, 55 destructive.
About Moneybird
Moneybird is an online invoicing and accounting platform designed for small businesses and freelancers, offering features like invoicing, expense tracking, and financial reporting.
Categories: Finance & Accounting
How to connect Moneybird to Type.com
- Access
- Organization connection: one shared account for the workspace.
- MCP
- Selected payment-processing operations are not available through Type’s MCP server. Other operations remain available through MCP, subject to your connection’s permissions. These MCP restrictions do not apply within Type.
To add the connection, follow the steps in Space connections.
Documented operations
293 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
293 operations listed.
Administrations
- Read
List all administrations
Lists all administrations the current user has access to.
Assets
- Read
Get an asset by ID
Returns the asset with the given ID. Required scope(s) documents
- Read
List all assets
Returns a list of all assets. The list is paginated. Use the perpage and page parameters to control the pagination. Required scope(s) documents
- Write
Create a disposal
Creates a disposal for the asset at the given date. Requires the asset to not have a disposal already. Furthermore, the asset must be fully depreciated so the value of the asset at the disposal date must be zero. Required scope(s) documents
- Write
Create a reinvestment reserve purchase
Records that part of the asset's purchase value is funded from the reinvestment reserve ("herinvesteringsreserve"). The amount cannot exceed the asset's depreciatable value (purchase value minus residual value), and the asset's purchase date may not lie in the locked period.
- Write
Create a reinvestment reserve sale
Books the book result of the asset's disposal to the reinvestment reserve ("herinvesteringsreserve"). Requires the asset to have a disposal without a reinvestment reserve sale, and the disposal date may not lie in the locked period. Required scope(s) documents
- Write
Add a source to an asset
Adds a detail or general journal document entry as a source to an asset. The booking must have the same ledger account as the asset. Required scope(s) documents
- Write
Create an arbitrary value change
Creates an arbitrary value change for the asset at the given date. If the amount is larger than the value of the asset at the given date, a 422 error will be returned. Any existing linear value changes after the given date will be removed. Required scope(s) documents
- Write
Create a divestment value change
Creates a divestment value change for the asset at the given date. The remaining value of the asset will be taken from the balance sheet and the profit will be booked as book result.
- Write
Create a full depreciation value change
Creates a full depreciation value change for the asset at the given date. The remaining value of the asset will be taken from the balance sheet. The amount of the value change will automatically be set to the value of the asset at the given date.
- Write
Create a manual value change
Creates a manual value change for the asset at the given date. If the amount is larger than the value of the asset at the given date, a 422 error will be returned. Required scope(s) documents
- Write
Create linear value changes retroactively
Creates linear value changes that were not created yet. Use this if a new asset has just been created or if an arbitrary value change was created and the missing linear value changes need to be recalculated and recreated.
- Write
Update an asset
Updates the asset with the given ID. If the asset is active (the purchase date is in the past), only the name can be updated. Required scope(s) documents
- Write
Create a new asset
Creates a new asset. An asset on a land or building ledger account never has a depreciation plan. Leave out valuechangeplanattributes for those. Every other ledger account requires one. Required scope(s) documents
- Destructive
Delete a reinvestment reserve purchase
Removes the reinvestment reserve purchase from the asset. Required scope(s) documents
- Destructive
Delete a reinvestment reserve sale
Removes the reinvestment reserve sale from the asset's disposal. Required scope(s) documents
- Destructive
Delete a source
Deletes a source from an asset. Does not delete the detail or the asset Required scope(s) documents
- Destructive
Delete an asset
Deletes the asset with the given ID. Required scope(s) documents
Contacts
- Read
Get contact by customer id
Returns all information about a contact by the given customer id Required scope(s) Any of: estimates, salesinvoices, documents, bank or settings
- Read
List possible duplicate contacts
Returns groups of contacts in the administration that are considered possible duplicates of each other. Pages are sized by the total number of contacts across the groups they contain, not by the number of groups.
- Read
Filter contacts
Returns a paginated list of all contacts in the administration. Required scope(s) Any of: estimates, salesinvoices, documents, bank or settings
- Read
List all ids and versions
Returns all contacts in the administration. The list contains the contact id and the version of the contact. Check if the version of the contact is newer than the version you have stored locally, use the POST variant for fetching contacts with the given ids.
- Read
Fetch contacts with given ids
Given a list of contact ids, returns the contact information belonging to the contacts. Returns a maximum of 100 contacts, even if more ids are provided. Required scope(s) Any of: estimates, salesinvoices, documents, bank or settings
- Read
Get contact person
Returns all information about a contact person. Required scope(s) Any of: estimates, salesinvoices, documents, bank or settings
- Read
Get Moneybird Payments mandate
Returns information about the stored Moneybird Payments mandate. Only available when Moneybird Payments is enabled for the administration. Required scope(s) Any of: estimates, salesinvoices, documents, bank or settings
- Read
Get additional charges
Get the additional charges of the given contact. Required scope(s) salesinvoices
- Read
Get contact
Returns all information about a contact. Required scope(s) Any of: estimates, salesinvoices, documents, bank or settings
- Read
List all contacts
Returns a paginated list of contacts in the administration. Searching for contacts can be done by providing the query parameter with search terms.
- Write
Update a contact person
When updating a contact, you only need to provide the information you want to change. Attributes you don't provide in the request will not be updated. Required scope(s) Any of: estimates, salesinvoices, documents, bank or settings
- Write
Create a new contact person
Creating a new contact person in the administration requires at least a contactperson hash including firstname and lastname. Required scope(s) Any of: estimates, salesinvoices, documents, bank or settings
- Write
Request an URL for setting up a Moneybird Payments mandate
Obtains an URL for setting up a Moneybird Payments mandate. You must provide this URL to your contact to set-up the mandate. Your contact is required to make a 15 cent payment. Every generated URL using this endpoint is valid for 14 days after creation.
- Write
Request a new Moneybird Payments mandate
Sends a request for a Moneybird Payments mandate to a contact via e-mail. Your contact will receive an email containing a link to authorise direct debit payments through Moneybird Payments. Your contact is required to make a 15 cent payment.
- Write
Adds note to entity
Adds a note to the contact. Required scope(s) Any of: estimates, salesinvoices, documents, bank or settings
- Write
Create an additional charge to be invoiced at start of next period
At the end of the current period, the additional charges for a contact are merged where possible and an invoice will be created for them. The invoice will be scheduled for sending at the first day of the next month. Required scope(s) salesinvoices
- Write
Update a contact
When updating a contact, you only need to provide the information you want to change. Attributes you don't provide in the request will not be updated. Optional attributes can be removed by setting them to an empty string value.
- Write
Create a new contact
Creating a new contact in the administration requires at least a companyname or a firstname and lastname. When filling a custom field, both id and value are required. See the custom field example for more information.
- Destructive
Delete a contact person
Deletes a contact person. Required scope(s) Any of: estimates, salesinvoices, documents, bank or settings
- Destructive
Delete a stored Moneybird Payments mandate
Deletes the stored Moneybird Payments mandate for the contact. Only available when Moneybird Payments is enabled for the administration. Required scope(s) Any of: estimates, salesinvoices, documents, bank or settings
- Destructive
Destroys note from entity
Deletes a note from the contact. Required scope(s) Any of: estimates, salesinvoices, documents, bank or settings
- Destructive
Archive a contact
Archives a contact. Required scope(s) Any of: estimates, salesinvoices, documents, bank or settings
- Destructive
Delete a contact
Deletes a contact. Required scope(s) Any of: estimates, salesinvoices, documents, bank or settings
Custom fields
- Read
List all custom fields
Custom fields are used to add extra information to entities in the administration. The source field can be salesinvoices, contact or identity and defines for which entities the custom field can be used.
Customer contact portal
- Read
Get a temporary link to the invoices in the customer contact portal
Generate a temporary link to the invoices in the customer contact portal. The link will expire after 1 hour. Required scope(s) Any of: salesinvoices or estimates
- Read
Get a temporary link to the subscriptions in the customer contact portal
Generate a temporary link to the subscriptions in the customer contact portal. The link will expire after 1 hour. Creating the online sales link can be done using the Create online sales link endpoint. Required scope(s) Any of: salesinvoices or estimates
- Read
Get a temporary link to the customer contact portal
Generate a temporary link to the customer contact portal. The link will expire after 1 hour. Required scope(s) Any of: salesinvoices or estimates
Document styles
- Read
List all document styles
Returns a list of all document styles. Required scope(s) Any of: settings, salesinvoices or estimates
Documents: General documents
- Read
List ids and versions of general documents
Returns all documents in the administration. The list contains the document id and the version of the document. Check if the version of the document is newer than the version you have stored locally, use the POST variant for fetching documents with the given ids.
- Read
Fetch general documents with given ids
Given a list of document ids, returns the document information belonging to the documents. Returns a maximum of 100 documents, even if more ids are provided. Required scope(s) documents
- Read
Download attachment
Download the attachment. The response will be a redirect to a temporarily available URL where the attachment can be downloaded. Use the Location header in the response to download the attachment. Required scope(s) documents
- Read
Get general document
Returns a general document by id. Required scope(s) documents
- Read
Get general documents
Returns a paginated list of documents of this type in the administration. Required scope(s) documents
- Write
Adds note to entity
Adds a note to the general document. Required scope(s) documents
- Write
Add attachment to general document
Add an attachment to a general document. Required scope(s) documents
- Write
Update a general document
Updates a general document. Required scope(s) documents
- Write
Create a new general document
Creates a new general document. Required scope(s) documents
- Destructive
Destroys note from entity
Deletes a note from the general document. Required scope(s) documents
- Destructive
Delete an attachment
Deletes an attachment of an attachable. Required scope(s) documents
- Destructive
Delete a general document
Deletes a general document. Required scope(s) documents
Documents: General journal documents
- Read
List ids and versions of general journal documents
Returns all documents in the administration. The list contains the document id and the version of the document. Check if the version of the document is newer than the version you have stored locally, use the POST variant for fetching documents with the given ids.
- Read
Fetch general journal documents with given ids
Given a list of document ids, returns the document information belonging to the documents. Returns a maximum of 100 documents, even if more ids are provided. Required scope(s) documents
- Read
Download attachment
Download the attachment. The response will be a redirect to a temporarily available URL where the attachment can be downloaded. Use the Location header in the response to download the attachment. Required scope(s) documents
- Read
Get general journal document
Returns a general journal document by id. Required scope(s) documents
- Read
Get general journal documents
Returns a paginated list of documents of this type in the administration. The excludenewgeneraljournaldocuments parameter, when set to true, removes documents that are still in the new state from the response. It has no effect on other document types. Required scope(s) documents
- Write
Adds note to entity
Adds a note to the general journal document. Required scope(s) documents
- Write
Add attachment to general journal document
Add an attachment to a general journal document. Required scope(s) documents
- Write
Update a general journal document
Updates a general journal document. Required scope(s) documents
- Write
Create a new general journal document
Creates a new general journal document. Required scope(s) documents
- Destructive
Destroys note from entity
Deletes a note from the general journal document. Required scope(s) documents
- Destructive
Delete an attachment
Deletes an attachment of an attachable. Required scope(s) documents
- Destructive
Delete a general journal document
Deletes a general journal document. Required scope(s) documents
Documents: Purchase invoices
- Read
List ids and versions of purchase invoices
Returns all documents in the administration. The list contains the document id and the version of the document. Check if the version of the document is newer than the version you have stored locally, use the POST variant for fetching documents with the given ids.
- Read
Fetch purchase invoices with given ids
Given a list of document ids, returns the document information belonging to the documents. Returns a maximum of 100 documents, even if more ids are provided. Required scope(s) documents
- Read
Download attachment
Download the attachment. The response will be a redirect to a temporarily available URL where the attachment can be downloaded. Use the Location header in the response to download the attachment. Required scope(s) documents
- Read
Get purchase invoice
Returns a purchase invoice by id. Required scope(s) documents
- Read
Get purchase invoices
Returns a paginated list of documents of this type in the administration. Required scope(s) documents
- Write
Add attachment to purchase invoice
Add an attachment to a purchase invoice. Required scope(s) documents
- Write
Create a payment
Registers a payment for a purchase invoice. Required scope(s) documents
- Write
Update purchase invoice
Updates a purchase invoice. Required scope(s) documents
- Write
Adds note to entity
Adds a note to the purchase invoice. Required scope(s) documents
- Write
Create a new purchase invoice
Creates a new purchase invoice. Required scope(s) documents
- Destructive
Delete an attachment
Deletes an attachment of an attachable. Required scope(s) documents
- Destructive
Delete a payment
Deletes a payment from a purchase invoice. Required scope(s) documents
- Destructive
Delete a purchase invoices
Deletes a purchase invoice. Required scope(s) documents
- Destructive
Destroys note from entity
Deletes a note from the purchase invoice. Required scope(s) documents
Documents: Receipts
- Read
List ids and versions of receipts
Returns all documents in the administration. The list contains the document id and the version of the document. Check if the version of the document is newer than the version you have stored locally, use the POST variant for fetching documents with the given ids.
- Read
Fetch receipts with given ids
Given a list of document ids, returns the document information belonging to the documents. Returns a maximum of 100 documents, even if more ids are provided. Required scope(s) documents
- Read
Download attachment
Download the attachment. The response will be a redirect to a temporarily available URL where the attachment can be downloaded. Use the Location header in the response to download the attachment. Required scope(s) documents
- Read
Get a receipt
Returns a receipt by id. Required scope(s) documents
- Read
List receipts
Returns a paginated list of documents of this type in the administration. Required scope(s) documents
- Write
Add attachment to receipt
Add an attachment to a receipt. Required scope(s) documents
- Write
Create a payment
Registers a payment for a receipt. Required scope(s) documents
- Write
Update a receipt
Updates a receipt. Required scope(s) documents
- Write
Adds note to entity
Adds a note to the receipt. Required scope(s) documents
- Write
Create a new receipt
Creates a new receipt. Required scope(s) documents
- Destructive
Delete an attachment
Deletes an attachment of an attachable. Required scope(s) documents
- Destructive
Delete a payment
Deletes a payment from a receipt. Required scope(s) documents
- Destructive
Delete a receipts
Deletes a receipt. Required scope(s) documents
- Destructive
Destroys note from entity
Deletes a note from the receipt. Required scope(s) documents
Documents: Typeless documents
- Read
List ids and versions of typeless documents
Returns all documents in the administration. The list contains the document id and the version of the document. Check if the version of the document is newer than the version you have stored locally, use the POST variant for fetching documents with the given ids.
- Read
Fetch typeless documents with given ids
Given a list of document ids, returns the document information belonging to the documents. Returns a maximum of 100 documents, even if more ids are provided. Required scope(s) documents
- Read
Download attachment
Download the attachment. The response will be a redirect to a temporarily available URL where the attachment can be downloaded. Use the Location header in the response to download the attachment. Required scope(s) documents
- Read
Get a typeless document
Returns a typeless document by id. Required scope(s) documents
- Read
Get typeless documents
Returns a paginated list of documents of this type in the administration. Required scope(s) documents
- Write
Add attachment to typeless document
Add an attachment to a typeless document. Required scope(s) documents
- Write
Create a new typeless document
Creates a new typeless document. Required scope(s) documents
- Destructive
Delete an attachment
Deletes an attachment of an attachable. Required scope(s) documents
- Destructive
Delete a typeless document
Deletes a typeless document. Required scope(s) documents
Downloads
- Read
Download a file
Returns a redirect to the actual file download URL. The required permission scope depends on the download's type (for example exportdocuments requires documents, exportsalesinvoices requires salesinvoices, exportcontacts requires contacts, and report exports require the same per…
- Read
List all downloads
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.
Estimates
- Read
Get an estimate by estimateid
Returns all information about an estimate with the given estimate id Required scope(s) estimates
- Read
List all ids and versions
Returns all estimates in the administration. The list contains the id and version of the estimate. If the version of the estimate is newer than the version you have stored locally, use the POST variant to fetch estimates with the given ids. Required scope(s) estimates
- Read
Fetch estimates with given ids
Given a list of estimate ids, returns the estimate information belonging to the estimates. Returns a maximum of 100 estimates, even if more ids are provided. Required scope(s) estimates
- Read
Download attachment
Download the attachment. The response will be a redirect to a temporarily available URL where the attachment can be downloaded. Use the Location header in the response to download the attachment. Required scope(s) estimates
- Read
Download estimate PDF by id
Redirects to the download URL of the estimate as PDF. The link is valid for 30 seconds. Required scope(s) estimates
- Read
Get an estimate by id
Returns all information about an estimate. Required scope(s) estimates
- Read
List all estimates
Returns a paginated list of estimates in the administration. Required scope(s) estimates
- Write
Adds note to entity
Adds a note to the estimate. Required scope(s) estimates
- Write
Add attachment to estimate
Add an attachment to an estimate. Required scope(s) estimates
- Write
Bills an estimate
An invoice is created based on the accepted estimate. Required scope(s) estimates and salesinvoices
- Write
Changes the state of an estimate
Not every state change is allowed. e.g. open to billed is accepted, draft to open is not. Note: this only changes the state and does not perform other actions like sending or billing the estimate. Required scope(s) estimates
- Write
Sends an estimate
You can provide a send method, email address and message. If you don't provide any arguments, the defaults from the contact and workflow will be used. If you have sent the estimate before, then the settings from the previous sending are used instead of the defaults.
- Write
Updates an estimate
When updating an estimate, provide only the attributes you want to update. The other attributes will not be changed. Required scope(s) estimates
- Write
Creates a new estimate
Creates a new estimate. Required scope(s) estimates
- Destructive
Delete an attachment
Deletes an attachment of an attachable. Required scope(s) estimates
- Destructive
Destroys note from entity
Deletes a note from the estimate. Required scope(s) estimates
- Destructive
Deletes an estimate
Deletes an estimate. Required scope(s) estimates
External sales invoices
- Read
List all ids and versions
Returns the external sales invoices that match the filter. The list contains the id and the version of the external sales invoice.
- Read
Fetch external sales invoices with given ids
Given a list of external sales invoice ids, returns the external sales invoice information belonging to the external sales invoice. Returns a maximum of 100 external sales invoices, even if more ids are provided. Required scope(s) salesinvoices
- Read
Download attachment
Download the attachment. The response will be a redirect to a temporarily available URL where the attachment can be downloaded. Use the Location header in the response to download the attachment. Required scope(s) salesinvoices
- Read
Get an external sales invoice by id
Returns an external sales invoice in the administration. Required scope(s) salesinvoices
- Read
List all external invoices
Returns a paginated list of external sales invoices in the administration. Required scope(s) salesinvoices
- Write
Create external sales invoice from attachment
Creates an external sales invoice from an attachment. Required scope(s) salesinvoices
- Write
Adds note to entity
Adds a note to the external sales invoice. Required scope(s) salesinvoices
- Write
Create a payment
Registers a payment for a external sales invoice. Required scope(s) salesinvoices
- Write
Add attachment to external sales invoice
Add an attachment to an external sales invoice. Required scope(s) salesinvoices
- Write
Mark as dubious
This endpoint marks an external sales invoice as dubious. Required scope(s) salesinvoices
- Write
Mark as uncollectible
This endpoint marks an external sales invoice as uncollectible. Required scope(s) salesinvoices
- Write
Update an external sales invoice
When updating an external sales invoice, provide only the attributes you want to update. The other attributes will not be changed. Required scope(s) salesinvoices
- Write
Create an external sales invoice
Creates a new external sales invoice. Required scope(s) salesinvoices
- Destructive
Delete an attachment
Deletes an attachment of an attachable. Required scope(s) salesinvoices
- Destructive
Destroys note from entity
Deletes a note from the external sales invoice Required scope(s) salesinvoices
- Destructive
Delete a payment
Deletes a payment from an external sales invoice. Required scope(s) salesinvoices
- Destructive
Delete an external sales invoice
Deletes an external sales invoice. Required scope(s) salesinvoices
Financial accounts
- Read
Retrieve all available financial accounts for the administration
Retrieve the financial accounts for the administration. Only active financial accounts are returned; inactive (archived) accounts are omitted. Required scope(s) settings
Financial mutations
- Read
List all ids and versions
Returns the financial mutations that match the filter. The list contains the id and the version of the financial mutation.
- Read
Fetch financial mutations with given ids
Given a list of financial mutation ids, returns the financial mutation information belonging to the financial mutation. Returns a maximum of 100 financial mutations, even if more ids are provided. Required scope(s) bank
- Read
Get a financial mutation by id
Returns a single financial mutation in the administration. Required scope(s) bank
- Read
List all financial mutations
Returns a list of financial mutations in the administration. Limited to 100 financial mutations. If you need more financial mutations, use the synchronize API. Required scope(s) bank
- Write
Links a financial mutation to a booking
Linking a booking to a financial mutation allows you to process financial mutations. Financial mutations can be linked to invoices, documents, ledger accounts and payment batches. Only a financial mutation with settlementstate settled, authorised or pending can be linked.
- Destructive
Unlinks a booking from a financial mutation
Unlinks a booking from a financial mutation. Required scope(s) bank
Financial statements
- Write
Update a financial statement
When updating a financial statement, you only need to provide the information you want to change. Attributes you don't provide in the request will not be updated. Required scope(s) bank
- Write
Create a new financial statement
Creates a new financial statement. Provided financial mutations will be grouped in the statement. Required scope(s) bank
- Destructive
Delete a financial statement
Deletes a financial statement. Required scope(s) bank
Identities
- Read
Retrieve the default identity
Returns the default identity of this administration. Required scope(s) settings
- Read
Retrieve identity by given id
Returns the identity with the given id. Required scope(s) settings
- Read
Retrieve identities
An administration can have multiple identities, for example to cover multiple tradenames or offices. This does not include the default identity. Required scope(s) settings
- Write
Updates the default identity
Updates the default identity. Required scope(s) settings
- Write
Updates an identity
Updates an identity. Required scope(s) settings
- Write
Creates an identity
Most fields for an identity are required. You can provide zero or more custom fields, for each provided custom field value the id and value are required. Required scope(s) settings
- Destructive
Deletes an identity
Deletes an identity. Always returns a 204 status code even if the identity could not be deleted. Required scope(s) settings
Ledger accounts
- Read
Returns information about a ledger account
Returns information about a ledger account. Required scope(s) Any of: settings, salesinvoices, documents or estimates
- Read
List all ledger accounts of an administration
Returns a list of all the ledger accounts in the administration. Pagination is not supported for this endpoint. Required scope(s) Any of: settings, salesinvoices, documents or estimates
- Write
Updates a ledger account
Updates a ledger account. Required scope(s) settings
- Write
Creates a new ledger account
The accounttype determines the kind of ledger account, this can be any of the following values: noncurrentassets, currentassets, equity, provisions, noncurrentliabilities, currentliabilities, revenue, directcosts, expenses, otherincomeexpenses By providing the parentid, it is po…
- Destructive
Deletes a ledger account
Deletes or deactivates a ledger account. First, an attempt is made to deactivate the ledger account. If that fails, an attempt is made to delete the ledger account. Always returns a 204 status code even if the ledger account could not be deleted or deactivated.
Payments
- Read
Returns information about a payment
Returns information about a payment.
Products
- Read
Returns information about a product based on the identifier
Finds the product by the identifier field of the product. Required scope(s) settings
- Read
Returns information about a product
Returns information about a product. Required scope(s) settings
- Read
List all products of an administration
Returns a paginated list of products in the administration. Each page contains 10 products. You can use the page parameter to fetch the next page of products. Required scope(s) settings
- Write
Create online sales link
This call generates an online sales link, and allows pre-setting the contact for a checkout page. The link is valid for one hour Required scope(s) settings
- Write
Updates a product
Updates a product. Required scope(s) settings
- Write
Creates a new product
Creates a new product. Required scope(s) settings
- Destructive
Deletes a product
Deletes a product if it has no dependencies. If the product has associated details, subscription products, orders, or subscription templates, deletion is blocked and the product will be deactivated instead.
Projects
- Read
Returns information about a project
Returns information about a project. Required scope(s) settings
- Read
List all projects of an administration
Returns a paginated list of projects in the administration. Each page contains 25 projects. You can use the page parameter to fetch the next page of projects. It returns the active projects when no filter is applied. Required scope(s) settings
- Write
Updates a project
Updates a project. Requires permission to settings. Requires a unique name within the administration (if name is provided). Required scope(s) settings
- Write
Creates a new project
Creates a new project. Requires a unique name within the administration. Required scope(s) settings
- Destructive
Deletes a project
Deletes a project. When there are no linked entities (sales invoices, estimates, etc.) the project is deleted. When there are linked entities, the project gets the state archived. Required scope(s) settings
Purchase transactions
- Read
Get a purchase transaction by id
Get a purchase transaction by id. Required scope(s) bank
- Read
List all purchase transactions
Returns a list of purchase transactions in the administration. Required scope(s) bank
- Write
Upload a SEPA credit transfer file to create purchase transaction batches
Upload a SEPA credit transfer file (pain.001.001.09/Version 2019) to create purchase transaction batches. This endpoint requires an active Moneybird Banking account in the administration. Required scope(s) bank
- Destructive
Delete a purchase transaction
Delete a purchase transaction. Requires that the purchase transaction is pending and doesn't belong to a purchase transaction batch. Required scope(s) bank
Recurring sales invoices
- Read
List all IDs and versions
Returns all recurring sales invoices in the administration. The list contains the invoice id and the version of the recurring invoice.
- Read
Fetch recurring sales invoices with given IDs
Given a list of recurring sales invoice IDs, returns the details of the recurring invoices. Returns a maximum of 100 recurring invoices, even if more IDs are provided. Required scope(s) salesinvoices
- Read
Get a recurring sales invoice by id
Get a recurring sales invoice by id. Required scope(s) salesinvoices
- Read
List all recurring sales invoices
Returns a paginated list of recurring sales invoices in the administration. Required scope(s) salesinvoices
- Write
Updates a recurring sales invoice
Updates a recurring sales invoice. Only possible if the recurring sales invoice has no active subscription. Required scope(s) salesinvoices
- Write
Adds note to entity
Adds a note to the recurring sales invoice. Required scope(s) salesinvoices
- Write
Creates a new recurring sales invoice
A recurring sales invoice will create new sales invoices on set intervals. To create a new recurring sales invoice, you need to provide at least a contact and details for the invoice. Furthermore you need to determine the planning.
- Destructive
Destroy or deactivate a recurring sales invoice
A recurring sales invoice will be destroyed if it has not created any sales invoices. If it has created sales invoices, it will be deactivated. A recurring sales invoice that belongs to an active subscription is not changed. Required scope(s) salesinvoices
- Destructive
Destroys note from entity
Deletes a note from the recurring sales invoice. Required scope(s) salesinvoices
Reports
- Read
Assets report
Get the assets report for the administration. Required scope(s) documents
- Read
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
- Read
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.
- Read
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: openingbalance is the balance at its start and closingbalance the balance at its end.
- Read
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
- Read
Creditors aging report
Returns a creditors aging report for the specified administration. Required scope(s) documents
- Read
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) salesinvoices
- Read
Debtors aging report
Returns a debtors aging report for the specified administration. Required scope(s) salesinvoices
- Read
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
- Read
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
- Read
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.
- Read
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 salesinvoices
- Read
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.
- Read
General ledger report
Get the general ledger report for the administration showing all ledger accounts with their balances and movements during the specified period.
- Read
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.
- Read
Profit loss report
Get the profit loss report for the administration. Every byledgeraccount 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.
- Read
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) salesinvoices
- Read
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) salesinvoices
- Read
Subscriptions report
Get the subscriptions report for the administration. All values are for the last month of the specified period. For example, thisyear returns the values for December. Required scope(s) salesinvoices
- Read
Tax report
Get the tax report for the administration. taxrates 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.
- Read
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.
Sales invoices
- Read
Get an invoice by invoiceid
Get a sales invoice by the invoiceid field of the sales invoice. An invoice does not have an invoiceid when its a draft, so a draft is never found here. List drafts through GET /salesinvoices with state:draft and fetch one with GET /salesinvoices/{id}.
- Read
Get an invoice by reference
Get a sales invoice by the reference field of the sales invoice. Required scope(s) salesinvoices
- Read
List all ids and versions
Returns all sales invoices in the administration. The list contains the invoice id and the version of the invoice. Check if the version of the invoice is newer than the version you have stored locally, use the POST variant for fetching invoices with the given ids.
- Read
Fetch sales invoices with given ids
Given a list of sales invoice ids, returns the sales invoice information belonging to the invoices. Returns a maximum of 100 invoice, even if more ids are provided. Required scope(s) salesinvoices
- Read
Download sales invoice packing slip PDF by id
Redirects to the download URL of the sales invoice as packing slip PDF. The link is valid for 30 seconds. Required scope(s) salesinvoices
- Read
Download sales invoice PDF by id
Redirects to the download URL of the sales invoice as PDF. The link is valid for 30 seconds. Required scope(s) salesinvoices
- Read
Download sales invoice UBL by id
Download the sales invoice as UBL. Required scope(s) salesinvoices
- Read
Get an invoice by id
Returns a sales invoices in the administration. Note that the link in the url attribute will only work if viewing invoices online has been enabled and the invoice is not a draft. Required scope(s) salesinvoices
- Read
Download attachment
Download the attachment. The response will be a redirect to a temporarily available URL where the attachment can be downloaded. Use the Location header in the response to download the attachment. Required scope(s) salesinvoices
- Read
List all invoices
Returns a paginated list of sales invoices in the administration. Sorting with sort=dateasc does not work when the period includes today and the filter includes draft or scheduled invoices; the request then answers 400.
- Write
Sends a reminder
This endpoint sends a reminder to a contact. A reminder can contain multiple sales invoices. Reminders are grouped by workflow, identity and document style, so a contact with sales invoices with different workflows, will receive multiple reminders.
- Write
Add attachment to sales invoice
Add an attachment to a sales invoice. Required scope(s) salesinvoices
- Write
Duplicate to credit invoice
Duplicate a sales invoice to a new credit invoice. Required scope(s) salesinvoices
- Write
Mark as dubious
This endpoint marks a sales invoice as dubious. Required scope(s) salesinvoices
- Write
Mark as uncollectible
This endpoint marks a sales invoice as uncollectible. Required scope(s) salesinvoices
- Write
Pause sales invoice
This endpoint pauses a sales invoice. The automatic workflow steps will not be executed while the sales invoice is paused. Required scope(s) salesinvoices
- Write
Register a payment for a creditinvoice
Settles a credit invoice against the sales invoice it credits. On the settlements ledger account, one payment is booked on each invoice, so they settle against each other.
- Write
Resume sales invoice
This endpoint resumes the sales invoice. The automatic workflow steps will execute again after resuming. Required scope(s) salesinvoices
- Write
Sends an invoice
This endpoint provides two options: sending the invoice and scheduling sending in the future. When sending now, you can provide a send method, email address and message. If you don't provide any arguments, the defaults from the contact and workflow will be used.
- Write
Update a sales invoice
When updating a sales invoice, provide only the attributes you want to update. The other attributes will not be changed. Required scope(s) salesinvoices
- Write
Adds note to entity
Adds a note to the sales invoice. Required scope(s) salesinvoices
- Write
Create a payment
Registers a payment for a sales invoice. Required scope(s) salesinvoices
- Write
Create a sales invoice
Create a sales invoice with the parameters defined in the request body. Required scope(s) salesinvoices
- Destructive
Delete a sales invoice
Delete a sales invoice. Requires that the sales invoice has no pending payments and is not in a locked bookkeeping period. Required scope(s) salesinvoices
- Destructive
Delete an attachment
Deletes an attachment of an attachable. Required scope(s) salesinvoices
- Destructive
Destroys note from entity
Deletes a note from the sales invoice. Required scope(s) salesinvoices
- Destructive
Delete a payment
Delete a payment from a sales invoice. Required scope(s) salesinvoices
Subscription templates
- Read
List all subscription templates
This call retrieves a paginated list of all subscription templates available in the administration. Each page consists of up to 100 subscription templates. To access subsequent pages, utilize the page parameter to fetch the next set of subscription templates.
- Write
Create online sales link
This call generates an online sales link, and allows pre-setting the contact and start date for a subscription. The link is valid for one hour Required scope(s) settings
Subscriptions
- Read
Get additional charges
Get the additional charges of the given subscription. Required scope(s) salesinvoices
- Read
Get subscription
Get a subscription. Required scope(s) salesinvoices
- Read
List subscriptions of a contact
Lists the subscriptions of a single contact. There is no endpoint that returns the subscriptions of every contact at once. Required scope(s) salesinvoices
- Write
Create an additional charge to be invoiced together with the subscription
At the end of the current subscription period, the additional charges are merged where possible and an invoice will be created for them. The invoice will be scheduled for sending together with the subscription invoice, so that they are merged on sending.
- Write
Create and schedule an invoice to be sent together with the subscription
Besides the recurring sales invoice for the subscription, you sometimes need to bill separate costs like usage based charges. Ideally you want these costs to be on the same invoice as the subscription invoice.
- Write
Update a subscription
Updates the product the contact is subscribed to. This will automatically calculate the differences between the product prices and create a one off sales invoice to bill the extra charge for the remaining billing period.
- Write
Create a new subscription
Starts a new subscription for the given contact. The productid points to a product with a frequency, price and description. A recurring sales invoice is automatically created to bill the contact for the given frequency.
- Destructive
Cancel a subscription
Cancels the subscription. Stops the recurring sales invoice for the contact. Optionally you can provide an enddate to stop the subscription on a future date. Required scope(s) salesinvoices
Task lists
- Read
Returns information about a task list group
Returns information about a task list group, including its tasks. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Read
Returns information about a task
Returns information about a task, including its subtasks, notes, and events. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Read
Returns information about a task list
Returns information about a task list, including its groups, tasks, and subtasks. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Read
List all task lists of an administration
Returns a paginated list of task lists in the administration. Each page contains 30 task lists by default. Use the page parameter to fetch the next page. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Write
Updates a task list group
Updates a task list group's name or report type. Updating the report type will destroy all tasks and generate new tasks based on the new report. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Write
Creates a new task in a group
Creates a new task in the specified task list group. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Write
Updates a task
Updates a task's attributes. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Write
Assigns a user to a task
Assigns a user to the specified task. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Write
Completes a task
Marks a task and all its subtasks as completed. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Write
Creates a note on a task
Creates a new note on the specified task. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Write
Creates a task list from a template
Creates a new task list based on the specified template. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Write
Updates a task list
Updates a task list's name, description, or deadline. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Write
Creates a new group in a task list
Creates a new group in the specified task list. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Write
Creates a new task list
Creates a new task list. Optionally, you can provide a templateid to create the task list from a template. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Destructive
Deletes a task list group
Permanently deletes a task list group and all its tasks. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Destructive
Deletes a task
Permanently deletes a task and all its subtasks. Generated tasks cannot be deleted. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Destructive
Unassigns the user from a task
Removes the current assignment from the specified task. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Destructive
Reopens a task
Reopens a completed task and possible parent tasks. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Destructive
Deletes a task list
Permanently deletes a task list and all its groups and tasks. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
Task list templates
- Read
Returns information about a task list template
Returns information about a task list template, including its groups and tasks. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Read
List all task list templates of an administration
Returns all task list templates in the administration. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Write
Updates a task list template
Updates a task list template. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Write
Creates a new group in a task list template
Creates a new group in the specified task list template. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Write
Creates a new task list template
Creates a new task list template. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
- Destructive
Deletes a task list template
Permanently deletes a task list template and all its groups and tasks. Required scope(s) All of: bank, documents, estimates, salesinvoices, settings and timeentries
Tax rates
- Read
List all available tax rates for the administration
Returns a paginated list of all available tax rates for the administration Required scope(s) Any of: settings, salesinvoices, documents or estimates
Time entries
- Read
Get a time entry by id
Returns a time entry in the administration. Required scope(s) timeentries
- Read
List all time entries
Returns a paginated list of time entries in the administration. Required scope(s) timeentries
- Write
Resume a stopped timer
Resumes a stopped time entry. If another time entry is currently active, it will be stopped first. Can only resume timers that started today. Required scope(s) timeentries
- Write
Stops an active time entry
Stops an active time entry. If the time entry is already stopped, the time entry is returned unchanged. Required scope(s) timeentries
- Write
Update a time entry
When updating a time entry, provide only the attributes you want to update. The other attributes will not be changed. startedat and endedat are rounded down to full minutes when updating a time entry, with a minimum of 1 minute between them. Required scope(s) timeentries
- Write
Adds note to entity
Adds a note to the time entry. Required scope(s) timeentries
- Write
Create a time entry
API to post a time entry. Used to create time entries to record time spent by an employee. Api user needs access to both sales invoices and time entries for this action.
- Destructive
Delete a time entry
Delete a time entry by id. Required scope(s) timeentries
- Destructive
Destroys note from entity
Deletes a note from a time entry. Required scope(s) timeentries
Users
- Read
List all users
Returns a list of users within the administration. Required scope(s) settings
Verifications
- Read
Retrieve verifications
Retrieve all the verifications within an administration. Returns all verified e-mail addresses and bank account numbers, as well as the verified chamber of commerce number and tax number. Required scope(s) settings
Webhooks
- Read
List all webhooks
List all registered webhooks for the administration. Required scope(s) settings
- Write
Activate a webhook
Activates a previously deactivated webhook. After activation, the webhook will resume receiving event notifications. Required scope(s) settings
- Write
Deactivate a webhook
Deactivates a webhook. A deactivated webhook will not receive new event notifications, but existing retries will still be processed. The webhook can be reactivated at any time. Required scope(s) settings
- Write
Create a webhook
Creates a new webhook. The provided URL should respond with a 200 HTTP status. After creation, the URL will receive notifications when events on documents in the administration occur.
- Destructive
Delete a webhook
Remove a registered webhook. Required scope(s) settings
Workflows
- Read
Get a workflow by id
Returns all information about a workflow. Required scope(s) Any of: settings, salesinvoices, documents, estimates or bank
- Read
Retrieve available workflows
Returns a list of all the workflows of an administration. Required scope(s) Any of: settings, salesinvoices, documents, estimates or bank
No operations match.
See How connections work for access and permissions, or browse all integrations.