Reference
Invoices, quotes, relations and bank transactions. Samples show the envelope; data.object of an event that has a snapshot carries the object's fields as of the event (shown here with its type and id). See the envelope.
attachment.matched#
A document was matched to a transaction.
Object: process_document · module process_documents: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b10",
"object": "event",
"type": "attachment.matched",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1000",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "ProcessDocument",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
bank_account.created#
A bank account was added to a company.
Object: bank_account · module banking: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b11",
"object": "event",
"type": "bank_account.created",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1001",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "BankAccount",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
bank_account.updated#
A bank account changed.
Object: bank_account · module banking: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b12",
"object": "event",
"type": "bank_account.updated",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1002",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "BankAccount",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
bank_transaction.booked#
A bank transaction was booked.
Object: bank_transaction · module banking: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b13",
"object": "event",
"type": "bank_transaction.booked",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1003",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "BankTransaction",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
bank_transaction.created#
A bank transaction arrived (feed, file or import).
Object: bank_transaction · module banking: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b14",
"object": "event",
"type": "bank_transaction.created",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1004",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "BankTransaction",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
bank_transaction.needs_receipt#
A booked transaction still needs a receipt.
Object: bank_transaction · module banking: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b15",
"object": "event",
"type": "bank_transaction.needs_receipt",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1005",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "BankTransaction",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
bank_transaction.needs_review#
A transaction needs a person to look at it.
Object: bank_transaction · module banking: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b16",
"object": "event",
"type": "bank_transaction.needs_review",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1006",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "BankTransaction",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
bank_transaction.unbooked#
The booking of a bank transaction was undone.
Object: bank_transaction · module banking: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b17",
"object": "event",
"type": "bank_transaction.unbooked",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1007",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "BankTransaction",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
journal_entry.created#
A journal entry was booked through the platform API.
Object: journal_entry · module settlements: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b18",
"object": "event",
"type": "journal_entry.created",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1008",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "JournalEntry",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
purchase_invoice.approved#
A purchase invoice was approved.
Object: purchase_invoice · module purchase_invoices: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b19",
"object": "event",
"type": "purchase_invoice.approved",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1009",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "PurchaseInvoice",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
purchase_invoice.created#
A purchase invoice was received or created.
Object: purchase_invoice · module purchase_invoices: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b20",
"object": "event",
"type": "purchase_invoice.created",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1010",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "PurchaseInvoice",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
purchase_invoice.due#
A purchase invoice is due.
Object: purchase_invoice · module purchase_invoices: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b21",
"object": "event",
"type": "purchase_invoice.due",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1011",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "PurchaseInvoice",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
purchase_invoice.paid#
A purchase invoice was paid.
Object: purchase_invoice · module purchase_invoices: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b22",
"object": "event",
"type": "purchase_invoice.paid",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1012",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "PurchaseInvoice",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
purchase_invoice.processed#
A purchase invoice was processed.
Object: purchase_invoice · module purchase_invoices: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b23",
"object": "event",
"type": "purchase_invoice.processed",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1013",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "PurchaseInvoice",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
quote.accepted#
A quote was accepted.
Object: quote · module quotes: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b24",
"object": "event",
"type": "quote.accepted",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1014",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Quote",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
quote.sent#
A quote was sent.
Object: quote · module quotes: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b25",
"object": "event",
"type": "quote.sent",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1015",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Quote",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
relation.bank_account_changed#
The bank account of a relation changed.
Object: relation · module relations: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b26",
"object": "event",
"type": "relation.bank_account_changed",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1016",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Relation",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
relation.created#
A relation was created.
Object: relation · module relations: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b27",
"object": "event",
"type": "relation.created",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1017",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Relation",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
relation.updated#
A relation changed.
Object: relation · module relations: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b28",
"object": "event",
"type": "relation.updated",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1018",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Relation",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
reminder.paid#
A reminder was paid.
Object: reminder · module reminders: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b29",
"object": "event",
"type": "reminder.paid",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1019",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Reminder",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
reminder.sent#
A payment reminder was sent.
Object: reminder · module reminders: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b30",
"object": "event",
"type": "reminder.sent",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1020",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Reminder",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
sales_invoice.created#
A sales invoice was created through the platform API.
Object: sales_invoice · module sales_invoices: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b31",
"object": "event",
"type": "sales_invoice.created",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1021",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "SalesInvoice",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
sales_invoice.credited#
A sales invoice was credited.
Object: sales_invoice · module sales_invoices: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b32",
"object": "event",
"type": "sales_invoice.credited",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1022",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "SalesInvoice",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
sales_invoice.finalised#
A sales invoice was numbered and booked.
Object: sales_invoice · module sales_invoices: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b33",
"object": "event",
"type": "sales_invoice.finalised",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1023",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "SalesInvoice",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
sales_invoice.overdue#
A sales invoice is overdue.
Object: sales_invoice · module sales_invoices: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"object": "event",
"type": "sales_invoice.overdue",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1024",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "SalesInvoice",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
sales_invoice.paid#
A sales invoice was paid.
Object: sales_invoice · module sales_invoices: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b35",
"object": "event",
"type": "sales_invoice.paid",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1025",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "SalesInvoice",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
sales_invoice.sent#
A sales invoice was sent.
Object: sales_invoice · module sales_invoices: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b36",
"object": "event",
"type": "sales_invoice.sent",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1026",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "SalesInvoice",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}