ERP Purchasing Events 2.5.0:2.0.0 documentation

ERP Purchasing Events 2.5.0:2.0.0

AsyncAPI specification for purchasing 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.purchasing.events
Channel carrying all purchasing domain events from ERP.

ERP publishes PurchaseOrderWasCreated when a new purchase order is created.
Operation IDpublishPurchaseOrderWasCreated
Accepts the following message:
Purchase Order Was CreatedPurchaseOrderWasCreated
Full purchase-order snapshot emitted after creation.
application/json
Message IDPurchaseOrderWasCreated
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:"PurchaseOrderWasCreated"
eventVersion
number
Const:1
aggregateType
string
Const:"PurchaseOrder"
object [PurchaseOrderWasCreated]
uid: https://contracts.boodmo.com/schemas/purchasing/purchase_order_was_created.v1.schema.json
Event emitted when a new purchase order is created in ERP.

id
required
string
format: uuid
Unique identifier of the purchase order.

number
required
string
Human-readable PO number.

vendorId
required
string
Vendor identifier.

companyCode
required
string
ERP company code.

businessPlaceCode
required
string
Business place / GST registration unit code.

required
object
name
required
string
Delivery location name.

addressLine1
required
string
First line of the delivery address.

city
required
string
City.

state
required
string
State / province code.

postalCode
required
string
Postal / ZIP code.

Additional properties are NOT allowed.
poDate
required
string
format: date
Date the purchase order was created (YYYY-MM-DD).

status
required
string
Overall PO status.

Allowed values:
"New"
"Processing"
"Completed"
"Canceled"
"Closed"
confirmationDueAt
required
string | null
format: date-time
Deadline by which the vendor must confirm the PO (ISO 8601). Null when confirmation is not required.

required
array<object>
non-empty
Non-empty list of PO line items.

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

materialId
required
integer
Internal material / part identifier.

materialCode
required
string
Material code.

vendorPn
required
string
Vendor part number.

manufacturerId
required
string
Manufacturer identifier.

manufacturerCode
required
string
Manufacturer code / short name.

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

gstRate
required
string
must match: ^[0-9]+\.[0-9]{6}$
GST rate as a decimal string with exactly 6 decimal places, e.g. "18.000000".

orderedQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Ordered quantity with exactly 6 decimal places.

remainingQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Remaining (unfulfilled) quantity with exactly 6 decimal places.

cancelledQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Cancelled quantity with exactly 6 decimal places.

receivedQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Received quantity with exactly 6 decimal places.

status
required
string
Line item status.

Allowed values:
"New"
"Processing"
"Completed"
"Canceled"
"Closed"
confirmationStatus
required
string
Current confirmation status of the purchase-order line item.

Allowed values:
"NOT_REQUIRED"
"WAITING"
"PARTIALLY_CONFIRMED"
"CONFIRMED"
"OVERDUE"
dispatchDueAt
required
string
format: date-time
Expected dispatch deadline for this line item (ISO 8601).

invoiceDueAt
required
string
format: date-time
Deadline by which the invoice for this line item is due (ISO 8601).

stockType
required
string
Inventory stock type.

Allowed values:
"STOCK"
"NON_STOCK"
"CONSIGNMENT"
sourcePriceListId
required
string
format: uuid
UUID of the price list entry that sourced this line item.

netPriceCents
required
integer
Net price per unit in cents (integers representing monetary values).

requestCancelQuantity
required
string
must match: ^[0-9]+\.[0-9]{6}$
Requested cancellation quantity with exactly 6 decimal places.

version
required
integer
>= 1
Optimistic lock version of the line item.

Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are allowed.
Examples
#1 Example - created-po-example
Envelope carrying a newly created two-line purchase order
{ "specVersion": "1", "messageId": "7b9f1c34-1c2d-4f7a-9b2e-2c3a4d5e6f70", "eventType": "PurchaseOrderWasCreated", "eventVersion": 1, "producer": "erp", "occurredAt": "2026-04-28T05:30:00Z", "aggregateType": "PurchaseOrder", "aggregateId": "01f63420-4214-44e0-ba9b-10daf956aacd", "payload": { "id": "01f63420-4214-44e0-ba9b-10daf956aacd", "number": "PO-4500012345", "vendorId": "V-1001", "companyCode": "1000", "businessPlaceCode": "BP-MUM", "delivery": { "name": "Boodmo Mumbai Warehouse", "addressLine1": "Warehouse Road 12", "city": "Mumbai", "state": "MH", "postalCode": "400001" }, "poDate": "2026-04-28", "status": "New", "confirmationDueAt": "2026-04-29T05:30:00Z", "items": [ { "id": "c2ca1be7-3122-45f0-97b2-0b7243fcfbcf", "materialId": 12345, "materialCode": "ABC123", "vendorPn": "SUP-11", "manufacturerId": "M-100", "manufacturerCode": "BOSCH", "hsnCode": "87089900", "gstRate": "18.000000", "orderedQty": "5.000000", "remainingQty": "5.000000", "cancelledQty": "0.000000", "receivedQty": "0.000000", "status": "New", "confirmationStatus": "WAITING", "dispatchDueAt": "2026-04-30T12:30:00Z", "invoiceDueAt": "2026-05-05T12:30:00Z", "stockType": "STOCK", "sourcePriceListId": "0ceb9e33-ea4f-40be-ab5f-f96a691469b4", "netPriceCents": 4500, "requestCancelQuantity": "0.000000", "version": 1 }, { "id": "802f7a9d-cc7b-4f25-9544-fb6428eab3a2", "materialId": 67890, "materialCode": "XYZ555", "vendorPn": "SUP-99", "manufacturerId": "M-200", "manufacturerCode": "DENSO", "hsnCode": "84099900", "gstRate": "12.000000", "orderedQty": "3.000000", "remainingQty": "3.000000", "cancelledQty": "0.000000", "receivedQty": "0.000000", "status": "New", "confirmationStatus": "WAITING", "dispatchDueAt": "2026-05-02T12:30:00Z", "invoiceDueAt": "2026-05-07T12:30:00Z", "stockType": "STOCK", "sourcePriceListId": "0ceb9e33-ea4f-40be-ab5f-f96a691469b4", "netPriceCents": 3200, "requestCancelQuantity": "0.000000", "version": 1 } ] } }
SEND erp.purchasing.events
Channel carrying all purchasing domain events from ERP.

ERP publishes PurchaseOrderChanged when purchase-order header fields change.
Operation IDpublishPurchaseOrderChanged
Accepts the following message:
Purchase Order ChangedPurchaseOrderChanged
Purchase-order header snapshot emitted when header fields change.
application/json
Message IDPurchaseOrderChanged
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:"PurchaseOrderChanged"
eventVersion
number
Const:1
aggregateType
string
Const:"PurchaseOrder"
object [PurchaseOrderChanged]
uid: https://contracts.boodmo.com/schemas/purchasing/purchase_order_changed.v1.schema.json
Event emitted when an existing purchase order is changed in ERP.

id
required
string
format: uuid
Unique identifier of the purchase order.

number
required
string
Human-readable PO number.

vendorId
required
string
Vendor identifier.

companyCode
required
string
ERP company code.

businessPlaceCode
required
string
Business place / GST registration unit code.

required
object
name
required
string
Delivery location name.

addressLine1
required
string
First line of the delivery address.

city
required
string
City.

state
required
string
State / province code.

postalCode
required
string
Postal / ZIP code.

Additional properties are NOT allowed.
poDate
required
string
format: date
Date the purchase order was created (YYYY-MM-DD).

status
required
string
Overall PO status.

Allowed values:
"New"
"Processing"
"Completed"
"Canceled"
"Closed"
confirmationDueAt
required
string | null
format: date-time
Deadline by which the vendor must confirm the PO (ISO 8601). Null when confirmation is not required.

Additional properties are NOT allowed.
Additional properties are allowed.
Examples
#1 Example - changed-po-header-example
Envelope carrying a changed purchase-order header snapshot
{ "specVersion": "1", "messageId": "4ea5a22c-0d83-4a30-85c4-8cf31d6ffd1d", "eventType": "PurchaseOrderChanged", "eventVersion": 1, "producer": "erp", "occurredAt": "2026-04-28T05:30:00Z", "aggregateType": "PurchaseOrder", "aggregateId": "01f63420-4214-44e0-ba9b-10daf956aacd", "payload": { "id": "01f63420-4214-44e0-ba9b-10daf956aacd", "number": "PO-4500012345", "vendorId": "V-1001", "companyCode": "1000", "businessPlaceCode": "BP-MUM", "delivery": { "name": "Boodmo Mumbai Warehouse", "addressLine1": "Warehouse Road 12", "city": "Mumbai", "state": "MH", "postalCode": "400001" }, "poDate": "2026-04-28", "status": "New", "confirmationDueAt": "2026-04-29T05:30:00Z" } }
SEND erp.purchasing.events
Channel carrying all purchasing domain events from ERP.

ERP publishes PurchaseOrderItemChanged when a purchase-order line item changes.
Operation IDpublishPurchaseOrderItemChanged
Accepts the following message:
Purchase Order Item ChangedPurchaseOrderItemChanged
Single purchase-order line-item snapshot emitted when an item changes.
application/json
Message IDPurchaseOrderItemChanged
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:"PurchaseOrderItemChanged"
eventVersion
number
Const:1
aggregateType
string
Const:"PurchaseOrderItem"
object [PurchaseOrderItemChanged]
uid: https://contracts.boodmo.com/schemas/purchasing/purchase_order_item_changed.v1.schema.json
Event emitted when a purchase order line item is changed in ERP.

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

materialId
required
integer
Internal material / part identifier.

materialCode
required
string
Material code.

vendorPn
required
string
Vendor part number.

manufacturerId
required
string
Manufacturer identifier.

manufacturerCode
required
string
Manufacturer code / short name.

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

gstRate
required
string
must match: ^[0-9]+\.[0-9]{6}$
GST rate as a decimal string with exactly 6 decimal places, e.g. "18.000000".

orderedQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Ordered quantity with exactly 6 decimal places.

remainingQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Remaining (unfulfilled) quantity with exactly 6 decimal places.

cancelledQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Cancelled quantity with exactly 6 decimal places.

receivedQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Received quantity with exactly 6 decimal places.

status
required
string
Line item status.

Allowed values:
"New"
"Processing"
"Completed"
"Canceled"
"Closed"
confirmationStatus
required
string
Current confirmation status of the purchase-order line item.

Allowed values:
"NOT_REQUIRED"
"WAITING"
"PARTIALLY_CONFIRMED"
"CONFIRMED"
"OVERDUE"
dispatchDueAt
required
string
format: date-time
Expected dispatch deadline for this line item (ISO 8601).

invoiceDueAt
required
string
format: date-time
Deadline by which the invoice for this line item is due (ISO 8601).

stockType
required
string
Inventory stock type.

Allowed values:
"STOCK"
"NON_STOCK"
"CONSIGNMENT"
sourcePriceListId
required
string
format: uuid
UUID of the price list entry that sourced this line item.

netPriceCents
required
integer
Net price per unit in cents (integers representing monetary values).

requestCancelQuantity
required
string
must match: ^[0-9]+\.[0-9]{6}$
Requested cancellation quantity with exactly 6 decimal places.

version
required
integer
>= 1
Optimistic lock version of the line item.

Additional properties are NOT allowed.
Additional properties are allowed.
Examples
#1 Example - changed-po-item-example
Envelope carrying one changed purchase-order line item
{ "specVersion": "1", "messageId": "0dd4e038-cd3d-477d-8dd8-874433ece656", "eventType": "PurchaseOrderItemChanged", "eventVersion": 1, "producer": "erp", "occurredAt": "2026-04-28T05:45:00Z", "aggregateType": "PurchaseOrderItem", "aggregateId": "c2ca1be7-3122-45f0-97b2-0b7243fcfbcf", "payload": { "id": "c2ca1be7-3122-45f0-97b2-0b7243fcfbcf", "materialId": 12345, "materialCode": "ABC123", "vendorPn": "SUP-11", "manufacturerId": "M-100", "manufacturerCode": "BOSCH", "hsnCode": "87089900", "gstRate": "18.000000", "orderedQty": "5.000000", "remainingQty": "4.000000", "cancelledQty": "0.000000", "receivedQty": "1.000000", "status": "Processing", "confirmationStatus": "PARTIALLY_CONFIRMED", "dispatchDueAt": "2026-04-30T12:30:00Z", "invoiceDueAt": "2026-05-05T12:30:00Z", "stockType": "STOCK", "sourcePriceListId": "0ceb9e33-ea4f-40be-ab5f-f96a691469b4", "netPriceCents": 4500, "requestCancelQuantity": "0.500000", "version": 1 } }
SEND erp.purchasing.events
Channel carrying all purchasing domain events from ERP.

ERP publishes PurchaseOrderItemCancellationRequested when a line-item cancellation is requested.
Operation IDpublishPurchaseOrderItemCancellationRequested
Accepts the following message:
Purchase Order Item Cancellation RequestedPurchaseOrderItemCancellationRequested
Cancellation request emitted for a single purchase-order line item.
application/json
Message IDPurchaseOrderItemCancellationRequested
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:"PurchaseOrderItemCancellationRequested"
eventVersion
number
Const:1
aggregateType
string
Const:"PurchaseOrderItem"
object [PurchaseOrderItemCancellationRequested]
uid: https://contracts.boodmo.com/schemas/purchasing/purchase_order_item_cancellation_requested.v1.schema.json
Event emitted when cancellation is requested for a purchase order line item.

id
required
string
format: uuid
Unique identifier of the purchase order line item.

requestedCancelQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Requested cancellation quantity with exactly 6 decimal places.

reasonCode
string | null
Optional machine-readable reason code for the cancellation request.

Additional properties are NOT allowed.
Additional properties are allowed.
Examples
#1 Example - item-cancellation-requested-example
Envelope carrying a line-item cancellation request
{ "specVersion": "1", "messageId": "6bc4f6a7-9c5e-4f33-8ed5-7d81a1f0a2a9", "eventType": "PurchaseOrderItemCancellationRequested", "eventVersion": 1, "producer": "erp", "occurredAt": "2026-04-28T06:00:00Z", "aggregateType": "PurchaseOrderItem", "aggregateId": "c2ca1be7-3122-45f0-97b2-0b7243fcfbcf", "payload": { "id": "c2ca1be7-3122-45f0-97b2-0b7243fcfbcf", "requestedCancelQty": "2.000000", "reasonCode": "CUSTOMER_REQUEST" } }

Messages

#1Purchase Order Was CreatedPurchaseOrderWasCreated
Full purchase-order snapshot emitted after creation.
- application/json
Message IDPurchaseOrderWasCreated
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:"PurchaseOrderWasCreated"
eventVersion
number
Const:1
aggregateType
string
Const:"PurchaseOrder"
object [PurchaseOrderWasCreated]
uid: https://contracts.boodmo.com/schemas/purchasing/purchase_order_was_created.v1.schema.json
Event emitted when a new purchase order is created in ERP.

id
required
string
format: uuid
Unique identifier of the purchase order.

number
required
string
Human-readable PO number.

vendorId
required
string
Vendor identifier.

companyCode
required
string
ERP company code.

businessPlaceCode
required
string
Business place / GST registration unit code.

required
object
name
required
string
Delivery location name.

addressLine1
required
string
First line of the delivery address.

city
required
string
City.

state
required
string
State / province code.

postalCode
required
string
Postal / ZIP code.

Additional properties are NOT allowed.
poDate
required
string
format: date
Date the purchase order was created (YYYY-MM-DD).

status
required
string
Overall PO status.

Allowed values:
"New"
"Processing"
"Completed"
"Canceled"
"Closed"
confirmationDueAt
required
string | null
format: date-time
Deadline by which the vendor must confirm the PO (ISO 8601). Null when confirmation is not required.

required
array<object>
non-empty
Non-empty list of PO line items.

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

materialId
required
integer
Internal material / part identifier.

materialCode
required
string
Material code.

vendorPn
required
string
Vendor part number.

manufacturerId
required
string
Manufacturer identifier.

manufacturerCode
required
string
Manufacturer code / short name.

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

gstRate
required
string
must match: ^[0-9]+\.[0-9]{6}$
GST rate as a decimal string with exactly 6 decimal places, e.g. "18.000000".

orderedQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Ordered quantity with exactly 6 decimal places.

remainingQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Remaining (unfulfilled) quantity with exactly 6 decimal places.

cancelledQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Cancelled quantity with exactly 6 decimal places.

receivedQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Received quantity with exactly 6 decimal places.

status
required
string
Line item status.

Allowed values:
"New"
"Processing"
"Completed"
"Canceled"
"Closed"
confirmationStatus
required
string
Current confirmation status of the purchase-order line item.

Allowed values:
"NOT_REQUIRED"
"WAITING"
"PARTIALLY_CONFIRMED"
"CONFIRMED"
"OVERDUE"
dispatchDueAt
required
string
format: date-time
Expected dispatch deadline for this line item (ISO 8601).

invoiceDueAt
required
string
format: date-time
Deadline by which the invoice for this line item is due (ISO 8601).

stockType
required
string
Inventory stock type.

Allowed values:
"STOCK"
"NON_STOCK"
"CONSIGNMENT"
sourcePriceListId
required
string
format: uuid
UUID of the price list entry that sourced this line item.

netPriceCents
required
integer
Net price per unit in cents (integers representing monetary values).

requestCancelQuantity
required
string
must match: ^[0-9]+\.[0-9]{6}$
Requested cancellation quantity with exactly 6 decimal places.

version
required
integer
>= 1
Optimistic lock version of the line item.

Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are allowed.
#2Purchase Order ChangedPurchaseOrderChanged
Purchase-order header snapshot emitted when header fields change.
- application/json
Message IDPurchaseOrderChanged
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:"PurchaseOrderChanged"
eventVersion
number
Const:1
aggregateType
string
Const:"PurchaseOrder"
object [PurchaseOrderChanged]
uid: https://contracts.boodmo.com/schemas/purchasing/purchase_order_changed.v1.schema.json
Event emitted when an existing purchase order is changed in ERP.

id
required
string
format: uuid
Unique identifier of the purchase order.

number
required
string
Human-readable PO number.

vendorId
required
string
Vendor identifier.

companyCode
required
string
ERP company code.

businessPlaceCode
required
string
Business place / GST registration unit code.

required
object
name
required
string
Delivery location name.

addressLine1
required
string
First line of the delivery address.

city
required
string
City.

state
required
string
State / province code.

postalCode
required
string
Postal / ZIP code.

Additional properties are NOT allowed.
poDate
required
string
format: date
Date the purchase order was created (YYYY-MM-DD).

status
required
string
Overall PO status.

Allowed values:
"New"
"Processing"
"Completed"
"Canceled"
"Closed"
confirmationDueAt
required
string | null
format: date-time
Deadline by which the vendor must confirm the PO (ISO 8601). Null when confirmation is not required.

Additional properties are NOT allowed.
Additional properties are allowed.
#3Purchase Order Item ChangedPurchaseOrderItemChanged
Single purchase-order line-item snapshot emitted when an item changes.
- application/json
Message IDPurchaseOrderItemChanged
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:"PurchaseOrderItemChanged"
eventVersion
number
Const:1
aggregateType
string
Const:"PurchaseOrderItem"
object [PurchaseOrderItemChanged]
uid: https://contracts.boodmo.com/schemas/purchasing/purchase_order_item_changed.v1.schema.json
Event emitted when a purchase order line item is changed in ERP.

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

materialId
required
integer
Internal material / part identifier.

materialCode
required
string
Material code.

vendorPn
required
string
Vendor part number.

manufacturerId
required
string
Manufacturer identifier.

manufacturerCode
required
string
Manufacturer code / short name.

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

gstRate
required
string
must match: ^[0-9]+\.[0-9]{6}$
GST rate as a decimal string with exactly 6 decimal places, e.g. "18.000000".

orderedQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Ordered quantity with exactly 6 decimal places.

remainingQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Remaining (unfulfilled) quantity with exactly 6 decimal places.

cancelledQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Cancelled quantity with exactly 6 decimal places.

receivedQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Received quantity with exactly 6 decimal places.

status
required
string
Line item status.

Allowed values:
"New"
"Processing"
"Completed"
"Canceled"
"Closed"
confirmationStatus
required
string
Current confirmation status of the purchase-order line item.

Allowed values:
"NOT_REQUIRED"
"WAITING"
"PARTIALLY_CONFIRMED"
"CONFIRMED"
"OVERDUE"
dispatchDueAt
required
string
format: date-time
Expected dispatch deadline for this line item (ISO 8601).

invoiceDueAt
required
string
format: date-time
Deadline by which the invoice for this line item is due (ISO 8601).

stockType
required
string
Inventory stock type.

Allowed values:
"STOCK"
"NON_STOCK"
"CONSIGNMENT"
sourcePriceListId
required
string
format: uuid
UUID of the price list entry that sourced this line item.

netPriceCents
required
integer
Net price per unit in cents (integers representing monetary values).

requestCancelQuantity
required
string
must match: ^[0-9]+\.[0-9]{6}$
Requested cancellation quantity with exactly 6 decimal places.

version
required
integer
>= 1
Optimistic lock version of the line item.

Additional properties are NOT allowed.
Additional properties are allowed.
#4Purchase Order Item Cancellation RequestedPurchaseOrderItemCancellationRequested
Cancellation request emitted for a single purchase-order line item.
- application/json
Message IDPurchaseOrderItemCancellationRequested
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:"PurchaseOrderItemCancellationRequested"
eventVersion
number
Const:1
aggregateType
string
Const:"PurchaseOrderItem"
object [PurchaseOrderItemCancellationRequested]
uid: https://contracts.boodmo.com/schemas/purchasing/purchase_order_item_cancellation_requested.v1.schema.json
Event emitted when cancellation is requested for a purchase order line item.

id
required
string
format: uuid
Unique identifier of the purchase order line item.

requestedCancelQty
required
string
must match: ^[0-9]+\.[0-9]{6}$
Requested cancellation quantity with exactly 6 decimal places.

reasonCode
string | null
Optional machine-readable reason code for the cancellation request.

Additional properties are NOT allowed.
Additional properties are allowed.

ERP Purchasing Events 2.5.0:2.0.0

Operations

SEND erp.purchasing.events

Examples

#1 Example - created-po-example

SEND erp.purchasing.events

Examples

#1 Example - changed-po-header-example

SEND erp.purchasing.events

Examples

#1 Example - changed-po-item-example

SEND erp.purchasing.events

Examples

#1 Example - item-cancellation-requested-example

Messages