ERP Invoicing Events 2.2.0:1.0.0 documentation

ERP Invoicing Events 2.2.0:1.0.0

AsyncAPI specification for invoicing domain events published by the ERP integration layer. 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 erp.invoicing.events
Channel carrying all invoicing domain events from ERP.

ERP publishes InvoiceWasCreated when a new invoice is created.
Operation IDpublishInvoiceWasCreated
Accepts the following message:
Invoice Was CreatedInvoiceWasCreated
Full invoice snapshot (header + line items) emitted after creation.
application/json
Message IDInvoiceWasCreated
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:"InvoiceWasCreated"
eventVersion
number
Const:1
aggregateType
string
Const:"Invoice"
object [InvoiceWasCreated]
uid: https://contracts.boodmo.com/schemas/invoicing/invoice_was_created.v1.schema.json
Event emitted when an invoice is created in ERP. Carries a full invoice snapshot (header + line items).

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

type
required
string
Invoice document type, e.g. "INVOICE".

status
required
string
Current invoice status, e.g. "POSTED".

dueDate
required
string | null
format: date
Payment due date (YYYY-MM-DD). Null when not set.

vendorId
required
integer
Vendor identifier.

amountNet
required
integer
Net (pre-tax) invoice amount in minor currency units (paise), e.g. 606380 = 6063.80 INR.

amountTax
required
integer
Total tax amount in minor currency units (paise), e.g. 606380 = 6063.80 INR.

createdAt
required
string
format: date-time
Invoice creation timestamp (ISO 8601).

updatedAt
required
string
format: date-time
Invoice last-update timestamp (ISO 8601).

amountGross
required
integer
Gross (net + tax) invoice amount in minor currency units (paise), e.g. 606380 = 6063.80 INR.

blockReason
required
string | null
Reason the invoice is blocked for payment. Null when not blocked.

companyCode
required
string
ERP company code.

postingDate
required
string
format: date
Invoice posting date (YYYY-MM-DD).

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

paymentBlock
required
boolean
Whether the invoice is blocked for payment.

lineItemCount
required
integer
>= 0
Number of line items on the invoice.

quantityTotal
required
integer
Total quantity across all line items.

documentNumber
required
string
Vendor invoice document number.

businessPlaceCode
required
string
Business place / GST registration unit code.

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

Additional properties are NOT allowed.
required
array<object>
Invoice line items.

object
id
required
string
format: uuid
Unique identifier of the invoice line item.

mrp
required
integer | null
Maximum retail price per unit in minor currency units (paise), e.g. 606380 = 6063.80 INR. Null when not applicable.

uom
required
string
Unit of measure, e.g. "pcs".

lineNo
required
integer
Line number within the invoice.

hsnCode
required
string
HSN (Harmonised System of Nomenclature) code for GST purposes.

netPrice
required
integer
Net price per unit in minor currency units (paise), e.g. 606380 = 6063.80 INR.

quantity
required
integer
Invoiced quantity.

createdAt
required
string
format: date-time
Line item creation timestamp (ISO 8601).

updatedAt
required
string
format: date-time
Line item last-update timestamp (ISO 8601).

amountBase
required
integer
Line base amount (net price x quantity) in minor currency units (paise), e.g. 606380 = 6063.80 INR.

gstPercent
required
integer
[ 0 .. 100 ]
GST rate in whole percent, e.g. 0, 5 or 18.

materialId
required
integer | null
Internal material / part identifier. Null for non-material lines (e.g. charges).

description
required
string
Line item description.

materialCode
required
string | null
Material code. Null for non-material lines.

manufacturerId
required
integer | null
Manufacturer identifier. Null for non-material lines.

manufacturerCode
required
string | null
Manufacturer code / short name. Null for non-material lines.

Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are allowed.
Examples
#1 Example - created-invoice-example
Envelope carrying a newly created two-line invoice
{ "specVersion": "1", "messageId": "3f6a1d2e-8b4c-4e5f-9a7b-1c2d3e4f5a6b", "eventType": "InvoiceWasCreated", "eventVersion": 1, "producer": "erp", "occurredAt": "2026-09-30T15:40:42Z", "aggregateType": "Invoice", "aggregateId": "01a0f2e4-17e5-7192-beb1-88096f9fbefd", "payload": { "invoice": { "id": "01a0f2e4-17e5-7192-beb1-88096f9fbefd", "type": "INVOICE", "status": "POSTED", "dueDate": null, "vendorId": 1253, "amountNet": 513882, "amountTax": 92498, "createdAt": "2026-09-30T15:17:09+00:00", "updatedAt": "2026-09-30T15:40:42+00:00", "amountGross": 606380, "blockReason": null, "companyCode": "MTC", "postingDate": "2026-09-30", "documentDate": "2026-09-30", "paymentBlock": false, "lineItemCount": 2, "quantityTotal": 2, "documentNumber": "inv/test/123", "businessPlaceCode": "P_DL01", "sourceOfSupply": "01a0f2e4-17e5-7192-beb1-88096f9fbefd" }, "items": [ { "id": "01a0f2e4-1939-70c5-ab9a-fc08ee015b98", "mrp": 669500, "uom": "pcs", "lineNo": 10, "hsnCode": "87080808", "netPrice": 510636, "quantity": 1, "createdAt": "2026-09-30T15:17:10+00:00", "updatedAt": "2026-09-30T15:40:42+00:00", "amountBase": 510636, "gstPercent": 18, "materialId": 58334236, "description": "68001M55R02", "materialCode": "68001M55R02", "manufacturerId": 2456, "manufacturerCode": "MARUTI SUZUKI" }, { "id": "01a0f2ed-ac06-73d4-9c86-47a5ab86f8b0", "mrp": null, "uom": "pcs", "lineNo": 20, "hsnCode": "11111111", "netPrice": 3246, "quantity": 1, "createdAt": "2026-09-30T15:27:37+00:00", "updatedAt": "2026-09-30T15:40:42+00:00", "amountBase": 3246, "gstPercent": 18, "materialId": null, "description": "Platform Charges", "materialCode": null, "manufacturerId": null, "manufacturerCode": null } ] } }
SEND erp.invoicing.events
Channel carrying all invoicing domain events from ERP.

ERP publishes InvoiceWasUpdated when an existing invoice is updated.
Operation IDpublishInvoiceWasUpdated
Accepts the following message:
Invoice Was UpdatedInvoiceWasUpdated
Full invoice snapshot (header + line items) emitted after an update.
application/json
Message IDInvoiceWasUpdated
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:"InvoiceWasUpdated"
eventVersion
number
Const:1
aggregateType
string
Const:"Invoice"
object [InvoiceWasUpdated]
uid: https://contracts.boodmo.com/schemas/invoicing/invoice_was_updated.v1.schema.json
Event emitted when an invoice is updated in ERP. Carries a full invoice snapshot (header + line items).

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

type
required
string
Invoice document type, e.g. "INVOICE".

status
required
string
Current invoice status, e.g. "POSTED".

dueDate
required
string | null
format: date
Payment due date (YYYY-MM-DD). Null when not set.

vendorId
required
integer
Vendor identifier.

amountNet
required
integer
Net (pre-tax) invoice amount in minor currency units (paise), e.g. 606380 = 6063.80 INR.

amountTax
required
integer
Total tax amount in minor currency units (paise), e.g. 606380 = 6063.80 INR.

createdAt
required
string
format: date-time
Invoice creation timestamp (ISO 8601).

updatedAt
required
string
format: date-time
Invoice last-update timestamp (ISO 8601).

amountGross
required
integer
Gross (net + tax) invoice amount in minor currency units (paise), e.g. 606380 = 6063.80 INR.

blockReason
required
string | null
Reason the invoice is blocked for payment. Null when not blocked.

companyCode
required
string
ERP company code.

postingDate
required
string
format: date
Invoice posting date (YYYY-MM-DD).

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

paymentBlock
required
boolean
Whether the invoice is blocked for payment.

lineItemCount
required
integer
>= 0
Number of line items on the invoice.

quantityTotal
required
integer
Total quantity across all line items.

documentNumber
required
string
Vendor invoice document number.

businessPlaceCode
required
string
Business place / GST registration unit code.

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

Additional properties are NOT allowed.
required
array<object>
Invoice line items.

object
id
required
string
format: uuid
Unique identifier of the invoice line item.

mrp
required
integer | null
Maximum retail price per unit in minor currency units (paise), e.g. 606380 = 6063.80 INR. Null when not applicable.

uom
required
string
Unit of measure, e.g. "pcs".

lineNo
required
integer
Line number within the invoice.

hsnCode
required
string
HSN (Harmonised System of Nomenclature) code for GST purposes.

netPrice
required
integer
Net price per unit in minor currency units (paise), e.g. 606380 = 6063.80 INR.

quantity
required
integer
Invoiced quantity.

createdAt
required
string
format: date-time
Line item creation timestamp (ISO 8601).

updatedAt
required
string
format: date-time
Line item last-update timestamp (ISO 8601).

amountBase
required
integer
Line base amount (net price x quantity) in minor currency units (paise), e.g. 606380 = 6063.80 INR.

gstPercent
required
integer
[ 0 .. 100 ]
GST rate in whole percent, e.g. 0, 5 or 18.

materialId
required
integer | null
Internal material / part identifier. Null for non-material lines (e.g. charges).

description
required
string
Line item description.

materialCode
required
string | null
Material code. Null for non-material lines.

manufacturerId
required
integer | null
Manufacturer identifier. Null for non-material lines.

manufacturerCode
required
string | null
Manufacturer code / short name. Null for non-material lines.

Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are allowed.
Examples
#1 Example - updated-invoice-example
Envelope carrying an updated two-line invoice
{ "specVersion": "1", "messageId": "9c8b7a6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "eventType": "InvoiceWasUpdated", "eventVersion": 1, "producer": "erp", "occurredAt": "2026-09-30T15:40:42Z", "aggregateType": "Invoice", "aggregateId": "01a0f2e4-17e5-7192-beb1-88096f9fbefd", "payload": { "invoice": { "id": "01a0f2e4-17e5-7192-beb1-88096f9fbefd", "type": "INVOICE", "status": "POSTED", "dueDate": null, "vendorId": 1253, "amountNet": 513882, "amountTax": 92498, "createdAt": "2026-09-30T15:17:09+00:00", "updatedAt": "2026-09-30T15:40:42+00:00", "amountGross": 606380, "blockReason": null, "companyCode": "MTC", "postingDate": "2026-09-30", "documentDate": "2026-09-30", "paymentBlock": false, "lineItemCount": 2, "quantityTotal": 2, "documentNumber": "inv/test/123", "businessPlaceCode": "P_DL01", "sourceOfSupply": "01a0f2e4-17e5-7192-beb1-88096f9fbefd" }, "items": [ { "id": "01a0f2e4-1939-70c5-ab9a-fc08ee015b98", "mrp": 669500, "uom": "pcs", "lineNo": 10, "hsnCode": "87080808", "netPrice": 510636, "quantity": 1, "createdAt": "2026-09-30T15:17:10+00:00", "updatedAt": "2026-09-30T15:40:42+00:00", "amountBase": 510636, "gstPercent": 18, "materialId": 58334236, "description": "68001M55R02", "materialCode": "68001M55R02", "manufacturerId": 2456, "manufacturerCode": "MARUTI SUZUKI" }, { "id": "01a0f2ed-ac06-73d4-9c86-47a5ab86f8b0", "mrp": null, "uom": "pcs", "lineNo": 20, "hsnCode": "11111111", "netPrice": 3246, "quantity": 1, "createdAt": "2026-09-30T15:27:37+00:00", "updatedAt": "2026-09-30T15:40:42+00:00", "amountBase": 3246, "gstPercent": 18, "materialId": null, "description": "Platform Charges", "materialCode": null, "manufacturerId": null, "manufacturerCode": null } ] } }

Messages

#1Invoice Was CreatedInvoiceWasCreated
Full invoice snapshot (header + line items) emitted after creation.
- application/json
Message IDInvoiceWasCreated
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:"InvoiceWasCreated"
eventVersion
number
Const:1
aggregateType
string
Const:"Invoice"
object [InvoiceWasCreated]
uid: https://contracts.boodmo.com/schemas/invoicing/invoice_was_created.v1.schema.json
Event emitted when an invoice is created in ERP. Carries a full invoice snapshot (header + line items).

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

type
required
string
Invoice document type, e.g. "INVOICE".

status
required
string
Current invoice status, e.g. "POSTED".

dueDate
required
string | null
format: date
Payment due date (YYYY-MM-DD). Null when not set.

vendorId
required
integer
Vendor identifier.

amountNet
required
integer
Net (pre-tax) invoice amount in minor currency units (paise), e.g. 606380 = 6063.80 INR.

amountTax
required
integer
Total tax amount in minor currency units (paise), e.g. 606380 = 6063.80 INR.

createdAt
required
string
format: date-time
Invoice creation timestamp (ISO 8601).

updatedAt
required
string
format: date-time
Invoice last-update timestamp (ISO 8601).

amountGross
required
integer
Gross (net + tax) invoice amount in minor currency units (paise), e.g. 606380 = 6063.80 INR.

blockReason
required
string | null
Reason the invoice is blocked for payment. Null when not blocked.

companyCode
required
string
ERP company code.

postingDate
required
string
format: date
Invoice posting date (YYYY-MM-DD).

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

paymentBlock
required
boolean
Whether the invoice is blocked for payment.

lineItemCount
required
integer
>= 0
Number of line items on the invoice.

quantityTotal
required
integer
Total quantity across all line items.

documentNumber
required
string
Vendor invoice document number.

businessPlaceCode
required
string
Business place / GST registration unit code.

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

Additional properties are NOT allowed.
required
array<object>
Invoice line items.

object
id
required
string
format: uuid
Unique identifier of the invoice line item.

mrp
required
integer | null
Maximum retail price per unit in minor currency units (paise), e.g. 606380 = 6063.80 INR. Null when not applicable.

uom
required
string
Unit of measure, e.g. "pcs".

lineNo
required
integer
Line number within the invoice.

hsnCode
required
string
HSN (Harmonised System of Nomenclature) code for GST purposes.

netPrice
required
integer
Net price per unit in minor currency units (paise), e.g. 606380 = 6063.80 INR.

quantity
required
integer
Invoiced quantity.

createdAt
required
string
format: date-time
Line item creation timestamp (ISO 8601).

updatedAt
required
string
format: date-time
Line item last-update timestamp (ISO 8601).

amountBase
required
integer
Line base amount (net price x quantity) in minor currency units (paise), e.g. 606380 = 6063.80 INR.

gstPercent
required
integer
[ 0 .. 100 ]
GST rate in whole percent, e.g. 0, 5 or 18.

materialId
required
integer | null
Internal material / part identifier. Null for non-material lines (e.g. charges).

description
required
string
Line item description.

materialCode
required
string | null
Material code. Null for non-material lines.

manufacturerId
required
integer | null
Manufacturer identifier. Null for non-material lines.

manufacturerCode
required
string | null
Manufacturer code / short name. Null for non-material lines.

Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are allowed.
#2Invoice Was UpdatedInvoiceWasUpdated
Full invoice snapshot (header + line items) emitted after an update.
- application/json
Message IDInvoiceWasUpdated
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:"InvoiceWasUpdated"
eventVersion
number
Const:1
aggregateType
string
Const:"Invoice"
object [InvoiceWasUpdated]
uid: https://contracts.boodmo.com/schemas/invoicing/invoice_was_updated.v1.schema.json
Event emitted when an invoice is updated in ERP. Carries a full invoice snapshot (header + line items).

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

type
required
string
Invoice document type, e.g. "INVOICE".

status
required
string
Current invoice status, e.g. "POSTED".

dueDate
required
string | null
format: date
Payment due date (YYYY-MM-DD). Null when not set.

vendorId
required
integer
Vendor identifier.

amountNet
required
integer
Net (pre-tax) invoice amount in minor currency units (paise), e.g. 606380 = 6063.80 INR.

amountTax
required
integer
Total tax amount in minor currency units (paise), e.g. 606380 = 6063.80 INR.

createdAt
required
string
format: date-time
Invoice creation timestamp (ISO 8601).

updatedAt
required
string
format: date-time
Invoice last-update timestamp (ISO 8601).

amountGross
required
integer
Gross (net + tax) invoice amount in minor currency units (paise), e.g. 606380 = 6063.80 INR.

blockReason
required
string | null
Reason the invoice is blocked for payment. Null when not blocked.

companyCode
required
string
ERP company code.

postingDate
required
string
format: date
Invoice posting date (YYYY-MM-DD).

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

paymentBlock
required
boolean
Whether the invoice is blocked for payment.

lineItemCount
required
integer
>= 0
Number of line items on the invoice.

quantityTotal
required
integer
Total quantity across all line items.

documentNumber
required
string
Vendor invoice document number.

businessPlaceCode
required
string
Business place / GST registration unit code.

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

Additional properties are NOT allowed.
required
array<object>
Invoice line items.

object
id
required
string
format: uuid
Unique identifier of the invoice line item.

mrp
required
integer | null
Maximum retail price per unit in minor currency units (paise), e.g. 606380 = 6063.80 INR. Null when not applicable.

uom
required
string
Unit of measure, e.g. "pcs".

lineNo
required
integer
Line number within the invoice.

hsnCode
required
string
HSN (Harmonised System of Nomenclature) code for GST purposes.

netPrice
required
integer
Net price per unit in minor currency units (paise), e.g. 606380 = 6063.80 INR.

quantity
required
integer
Invoiced quantity.

createdAt
required
string
format: date-time
Line item creation timestamp (ISO 8601).

updatedAt
required
string
format: date-time
Line item last-update timestamp (ISO 8601).

amountBase
required
integer
Line base amount (net price x quantity) in minor currency units (paise), e.g. 606380 = 6063.80 INR.

gstPercent
required
integer
[ 0 .. 100 ]
GST rate in whole percent, e.g. 0, 5 or 18.

materialId
required
integer | null
Internal material / part identifier. Null for non-material lines (e.g. charges).

description
required
string
Line item description.

materialCode
required
string | null
Material code. Null for non-material lines.

manufacturerId
required
integer | null
Manufacturer identifier. Null for non-material lines.

manufacturerCode
required
string | null
Manufacturer code / short name. Null for non-material lines.

Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are allowed.

ERP Invoicing Events 2.2.0:1.0.0

Operations

SEND erp.invoicing.events

Examples

#1 Example - created-invoice-example

SEND erp.invoicing.events

Examples

#1 Example - updated-invoice-example

Messages