Grabby Invoicing Events 2.3.0:1.0.0 documentation

Grabby Invoicing Events 2.3.0:1.0.0

AsyncAPI specification for invoicing domain events published by Grabby. JSON Schema files under schemas/ are the authoritative contract. Every message uses the common integration envelope (schemas/common/integration_envelope.v1.schema.json); event-specific business data is embedded in the envelope payload field.

Operations

SEND grabby.invoicing.events
Channel carrying all invoicing domain events from Grabby.

Grabby publishes InvoiceRequestWasCreated when a new invoice request is created.
Operation IDpublishInvoiceRequestWasCreated
Accepts the following message:
Invoice Request Was CreatedInvoiceRequestWasCreated
Full invoice-request snapshot emitted after creation.
application/json
Message IDInvoiceRequestWasCreated
allOf
object [IntegrationEnvelope]
uid: https://contracts.boodmo.com/schemas/common/integration_envelope.v1.schema.json
Common wrapper carried by every integration event on the message bus. The business-domain payload is embedded in the 'payload' property.

specVersion
required
string
Envelope specification version, e.g. "1".

messageId
required
string
format: uuid
Globally unique identifier for this message instance.

eventType
required
string
Name of the domain event, e.g. "PurchaseOrderWasCreated".

eventVersion
required
integer
>= 1
Schema version of the event payload, e.g. 1.

producer
required
string
Identifier of the service that emitted this message, e.g. "erp".

occurredAt
required
string
format: date-time
ISO 8601 timestamp of when the domain event occurred.

aggregateType
required
string
Name of the aggregate root, e.g. "PurchaseOrder".

aggregateId
required
string
Identifier of the aggregate instance, typically a UUID.

required
object
Event-specific business payload. The concrete schema is defined per event type.

Additional properties are allowed.
Additional properties are NOT allowed.
object
eventType
string
Const:"InvoiceRequestWasCreated"
eventVersion
number
Const:1
aggregateType
string
Const:"InvoiceRequest"
object [InvoiceRequestWasCreated]
uid: https://contracts.boodmo.com/schemas/invoicing/invoice_request_was_created.v1.schema.json
Event emitted when a new invoice request is created in Grabby.

id
required
string
format: uuid
Unique identifier of the invoice request.

number
required
string
Human-readable invoice request number.

status
required
string
Current status of the invoice request, e.g. "posted".

vendorId
required
string
Vendor identifier.

plantCode
required
string
ERP plant code.

companyCode
required
string
ERP company code.

documentDate
required
string
format: date
Invoice document date (YYYY-MM-DD).

originalFile
required
string
File name of the original invoice document.

sourceOfSupply
required
string
format: uuid
Identifier of the source of supply.

materialReceived
required
string
Timestamp when the material was received, formatted as "YYYY-MM-DD HH:MM:SS".

businessPlaceCode
required
string
Business place / GST registration unit code.

Additional properties are NOT allowed.
Additional properties are allowed.
Examples
#1 Example - created-invoice-request-example
Envelope carrying a newly created invoice request
{ "specVersion": "1", "messageId": "7b9f1c34-1c2d-4f7a-9b2e-2c3a4d5e6f70", "eventType": "InvoiceRequestWasCreated", "eventVersion": 1, "producer": "grabby", "occurredAt": "2026-09-04T13:53:33Z", "aggregateType": "InvoiceRequest", "aggregateId": "01a06cb2-3668-710e-9fa8-9f4ab7cff8c4", "payload": { "id": "01a06cb2-3668-710e-9fa8-9f4ab7cff8c4", "number": "altkatest25-09-04-7", "status": "posted", "vendorId": "1252", "plantCode": "1001", "companyCode": "MTC", "documentDate": "2026-08-18", "originalFile": "1252_Invoice_With_Buyer_altkatest260904-7-wrong.pdf", "sourceOfSupply": "019f4baa-53dd-70a3-9d1d-984a2b207014", "materialReceived": "2026-09-04 13:53:33", "businessPlaceCode": "D001" } }
SEND grabby.invoicing.events
Channel carrying all invoicing domain events from Grabby.

Grabby publishes InvoiceRequestWasUpdated when an existing invoice request is updated.
Operation IDpublishInvoiceRequestWasUpdated
Accepts the following message:
Invoice Request Was UpdatedInvoiceRequestWasUpdated
Full invoice-request snapshot emitted after an update.
application/json
Message IDInvoiceRequestWasUpdated
allOf
object [IntegrationEnvelope]
uid: https://contracts.boodmo.com/schemas/common/integration_envelope.v1.schema.json
Common wrapper carried by every integration event on the message bus. The business-domain payload is embedded in the 'payload' property.

specVersion
required
string
Envelope specification version, e.g. "1".

messageId
required
string
format: uuid
Globally unique identifier for this message instance.

eventType
required
string
Name of the domain event, e.g. "PurchaseOrderWasCreated".

eventVersion
required
integer
>= 1
Schema version of the event payload, e.g. 1.

producer
required
string
Identifier of the service that emitted this message, e.g. "erp".

occurredAt
required
string
format: date-time
ISO 8601 timestamp of when the domain event occurred.

aggregateType
required
string
Name of the aggregate root, e.g. "PurchaseOrder".

aggregateId
required
string
Identifier of the aggregate instance, typically a UUID.

required
object
Event-specific business payload. The concrete schema is defined per event type.

Additional properties are allowed.
Additional properties are NOT allowed.
object
eventType
string
Const:"InvoiceRequestWasUpdated"
eventVersion
number
Const:1
aggregateType
string
Const:"InvoiceRequest"
object [InvoiceRequestWasUpdated]
uid: https://contracts.boodmo.com/schemas/invoicing/invoice_request_was_updated.v1.schema.json
Event emitted when an existing invoice request is updated in Grabby.

id
required
string
format: uuid
Unique identifier of the invoice request.

number
required
string
Human-readable invoice request number.

status
required
string
Current status of the invoice request, e.g. "posted".

vendorId
required
string
Vendor identifier.

plantCode
required
string
ERP plant code.

companyCode
required
string
ERP company code.

documentDate
required
string
format: date
Invoice document date (YYYY-MM-DD).

originalFile
required
string
File name of the original invoice document.

sourceOfSupply
required
string
format: uuid
Identifier of the source of supply.

materialReceived
required
string
Timestamp when the material was received, formatted as "YYYY-MM-DD HH:MM:SS".

businessPlaceCode
required
string
Business place / GST registration unit code.

Additional properties are NOT allowed.
Additional properties are allowed.
Examples
#1 Example - updated-invoice-request-example
Envelope carrying an updated invoice request
{ "specVersion": "1", "messageId": "4ea5a22c-0d83-4a30-85c4-8cf31d6ffd1d", "eventType": "InvoiceRequestWasUpdated", "eventVersion": 1, "producer": "grabby", "occurredAt": "2026-09-04T13:53:33Z", "aggregateType": "InvoiceRequest", "aggregateId": "01a06cb2-3668-710e-9fa8-9f4ab7cff8c4", "payload": { "id": "01a06cb2-3668-710e-9fa8-9f4ab7cff8c4", "number": "altkatest25-09-04-7", "status": "posted", "vendorId": "1252", "plantCode": "1001", "companyCode": "MTC", "documentDate": "2026-08-18", "originalFile": "1252_Invoice_With_Buyer_altkatest260904-7-wrong.pdf", "sourceOfSupply": "019f4baa-53dd-70a3-9d1d-984a2b207014", "materialReceived": "2026-09-04 13:53:33", "businessPlaceCode": "D001" } }

Messages

#1Invoice Request Was CreatedInvoiceRequestWasCreated
Full invoice-request snapshot emitted after creation.
- application/json
Message IDInvoiceRequestWasCreated
allOf
object [IntegrationEnvelope]
uid: https://contracts.boodmo.com/schemas/common/integration_envelope.v1.schema.json
Common wrapper carried by every integration event on the message bus. The business-domain payload is embedded in the 'payload' property.

specVersion
required
string
Envelope specification version, e.g. "1".

messageId
required
string
format: uuid
Globally unique identifier for this message instance.

eventType
required
string
Name of the domain event, e.g. "PurchaseOrderWasCreated".

eventVersion
required
integer
>= 1
Schema version of the event payload, e.g. 1.

producer
required
string
Identifier of the service that emitted this message, e.g. "erp".

occurredAt
required
string
format: date-time
ISO 8601 timestamp of when the domain event occurred.

aggregateType
required
string
Name of the aggregate root, e.g. "PurchaseOrder".

aggregateId
required
string
Identifier of the aggregate instance, typically a UUID.

required
object
Event-specific business payload. The concrete schema is defined per event type.

Additional properties are allowed.
Additional properties are NOT allowed.
object
eventType
string
Const:"InvoiceRequestWasCreated"
eventVersion
number
Const:1
aggregateType
string
Const:"InvoiceRequest"
object [InvoiceRequestWasCreated]
uid: https://contracts.boodmo.com/schemas/invoicing/invoice_request_was_created.v1.schema.json
Event emitted when a new invoice request is created in Grabby.

id
required
string
format: uuid
Unique identifier of the invoice request.

number
required
string
Human-readable invoice request number.

status
required
string
Current status of the invoice request, e.g. "posted".

vendorId
required
string
Vendor identifier.

plantCode
required
string
ERP plant code.

companyCode
required
string
ERP company code.

documentDate
required
string
format: date
Invoice document date (YYYY-MM-DD).

originalFile
required
string
File name of the original invoice document.

sourceOfSupply
required
string
format: uuid
Identifier of the source of supply.

materialReceived
required
string
Timestamp when the material was received, formatted as "YYYY-MM-DD HH:MM:SS".

businessPlaceCode
required
string
Business place / GST registration unit code.

Additional properties are NOT allowed.
Additional properties are allowed.
#2Invoice Request Was UpdatedInvoiceRequestWasUpdated
Full invoice-request snapshot emitted after an update.
- application/json
Message IDInvoiceRequestWasUpdated
allOf
object [IntegrationEnvelope]
uid: https://contracts.boodmo.com/schemas/common/integration_envelope.v1.schema.json
Common wrapper carried by every integration event on the message bus. The business-domain payload is embedded in the 'payload' property.

specVersion
required
string
Envelope specification version, e.g. "1".

messageId
required
string
format: uuid
Globally unique identifier for this message instance.

eventType
required
string
Name of the domain event, e.g. "PurchaseOrderWasCreated".

eventVersion
required
integer
>= 1
Schema version of the event payload, e.g. 1.

producer
required
string
Identifier of the service that emitted this message, e.g. "erp".

occurredAt
required
string
format: date-time
ISO 8601 timestamp of when the domain event occurred.

aggregateType
required
string
Name of the aggregate root, e.g. "PurchaseOrder".

aggregateId
required
string
Identifier of the aggregate instance, typically a UUID.

required
object
Event-specific business payload. The concrete schema is defined per event type.

Additional properties are allowed.
Additional properties are NOT allowed.
object
eventType
string
Const:"InvoiceRequestWasUpdated"
eventVersion
number
Const:1
aggregateType
string
Const:"InvoiceRequest"
object [InvoiceRequestWasUpdated]
uid: https://contracts.boodmo.com/schemas/invoicing/invoice_request_was_updated.v1.schema.json
Event emitted when an existing invoice request is updated in Grabby.

id
required
string
format: uuid
Unique identifier of the invoice request.

number
required
string
Human-readable invoice request number.

status
required
string
Current status of the invoice request, e.g. "posted".

vendorId
required
string
Vendor identifier.

plantCode
required
string
ERP plant code.

companyCode
required
string
ERP company code.

documentDate
required
string
format: date
Invoice document date (YYYY-MM-DD).

originalFile
required
string
File name of the original invoice document.

sourceOfSupply
required
string
format: uuid
Identifier of the source of supply.

materialReceived
required
string
Timestamp when the material was received, formatted as "YYYY-MM-DD HH:MM:SS".

businessPlaceCode
required
string
Business place / GST registration unit code.

Additional properties are NOT allowed.
Additional properties are allowed.

Grabby Invoicing Events 2.3.0:1.0.0

Operations

SEND grabby.invoicing.events

Examples

#1 Example - created-invoice-request-example

SEND grabby.invoicing.events

Examples

#1 Example - updated-invoice-request-example

Messages