Events
Events record what happened in the administration, such as a sales invoice that was sent or a contact that was changed.
List events
Returns the events of the administration, newest first: the same events the user sees in
the activity log of Moneybird. Give entity_type, entity_id or both; without either the
response is 400.
With entity_type, the user needs the permission for that record type, for example
sales_invoices for SalesInvoice, estimates for Estimate, documents for Document
and bank for FinancialMutation. Contact needs one of estimates, sales_invoices,
documents, bank or settings. Without the permission the response is 401. Events of
purchase invoices, receipts and the other document types have entity_type Document, so
asking for such a type gives 400 that names Document. An unknown record type gives 400 with
the record types the user can ask for. A user who only has the time_entries permission sees
only their own events.
The list is paginated with a cursor. Follow the URL in the Link header with rel="next"
for older events; the last page has no Link header. This list is not a reliable feed of new
events: an event can appear after events that were created later.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
per_page^\d+$cursorPosition in the list to continue from. Take the URL from the Link header with rel="next" instead of building it. A cursor that Moneybird did not make is refused with 400.
entity_typeOnly return events of this record type, for example Contact, SalesInvoice or Document. The user needs permission for this type.
entity_id^\d+$Only return the events of this record. Events of a record type the user has no permission for are left out.
A unique record identifier
List events › Responses
A list of events
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
user_id^\d+$A unique record identifier
actionentity_typeThe type of the record the event is about, for example Contact, SalesInvoice or Document. Purchase invoices, receipts and the other document types are Document.
entity_id^\d+$The record the event is about. Empty when that record was deleted.
link_entity_id^\d+$A unique record identifier
link_entity_typecreated_atupdated_at