ERP Invoicing Events dev:1.3.0 documentation

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.

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

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

string

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.

required

array<object>

Invoice-level pricing conditions (discounts, surcharges, charges). Array of condition value objects. Their inner structure is not formalized in this contract yet; currently shaped like {"kind": "AMOUNT", "rate": null, "type": "REBATE", "basis": "NET", "amount": {"cents": 56988, "currency": "INR"}, "position": 2}.

required

array<object>

Documents attached to the invoice. Array of attachment value objects. Their inner structure is not formalized in this contract yet; currently shaped like {"name": "invoice.pdf", "path": "supplier-invoices/.pdf", "type": "ORIGINAL", "timestamp": null}.

Additional properties are NOT allowed.

required

array<object>

Invoice line items.

object

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

number

>= 0

Invoiced quantity (decimal, e.g. 1.000000).

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.

priceUnitQty

required

integer

Price unit quantity: number of units the net price refers to (e.g. 1 = price per 1 unit).

lineDiscountValue

required

integer

Line discount value. Interpreted according to lineDiscountType: a percent when "percent", otherwise an absolute amount in minor currency units (paise).

lineSurchargeValue

required

integer

Line surcharge value. Interpreted according to lineSurchargeType: a percent when "percent", otherwise an absolute amount in minor currency units (paise).

required

array<object>

Taxes applied to the line. Array of tax value objects. Their inner structure is not formalized in this contract yet; currently shaped like {"rate": 0.09, "amount": {"cents": 1103, "currency": "INR"}, "taxCode": "CGST"} (rate is a fraction, e.g. 0.09 = 9%).

conditionNetPart

required

number

Line's share of invoice-level conditions applied to the net amount (decimal, e.g. 0.000000).

conditionGrossPart

required

number

Line's share of invoice-level conditions applied to the gross amount (decimal, e.g. 0.000000).

lineDiscountType

required

string

How lineDiscountValue is interpreted: "percent" or "constant" (absolute amount).

"percent"
"constant"

lineSurchargeType

required

string

How lineSurchargeValue is interpreted: "percent" or "constant" (absolute amount).

"percent"
"constant"

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",
      "conditions": [
        {
          "kind": "AMOUNT",
          "rate": null,
          "type": "REBATE",
          "basis": "NET",
          "amount": {
            "cents": 56988,
            "currency": "INR"
          },
          "position": 2
        }
      ],
      "attachments": [
        {
          "name": "1252_Invoice_With_Buyer_altkatest261002-7-wrongqty.pdf",
          "path": "supplier-invoices/1252_01a0fbcb-ef81-7079-b827-af158719b3f2.pdf",
          "type": "ORIGINAL",
          "timestamp": null
        }
      ]
    },
    "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",
        "priceUnitQty": 1,
        "lineDiscountValue": 0,
        "lineSurchargeValue": 0,
        "taxes": [
          {
            "rate": 0.09,
            "amount": {
              "cents": 45957,
              "currency": "INR"
            },
            "taxCode": "CGST"
          },
          {
            "rate": 0.09,
            "amount": {
              "cents": 45957,
              "currency": "INR"
            },
            "taxCode": "SGST"
          }
        ],
        "conditionNetPart": 0,
        "conditionGrossPart": 0,
        "lineDiscountType": "percent",
        "lineSurchargeType": "percent"
      },
      {
        "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,
        "priceUnitQty": 1,
        "lineDiscountValue": 0,
        "lineSurchargeValue": 0,
        "taxes": [
          {
            "rate": 0.09,
            "amount": {
              "cents": 292,
              "currency": "INR"
            },
            "taxCode": "CGST"
          },
          {
            "rate": 0.09,
            "amount": {
              "cents": 292,
              "currency": "INR"
            },
            "taxCode": "SGST"
          }
        ],
        "conditionNetPart": 0,
        "conditionGrossPart": 0,
        "lineDiscountType": "percent",
        "lineSurchargeType": "percent"
      }
    ]
  }
}

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.

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

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

string

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.

required

array<object>

required

array<object>

Additional properties are NOT allowed.

required

array<object>

Invoice line items.

object

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

number

>= 0

Invoiced quantity (decimal, e.g. 1.000000).

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.

priceUnitQty

required

integer

Price unit quantity: number of units the net price refers to (e.g. 1 = price per 1 unit).

lineDiscountValue

required

integer

Line discount value. Interpreted according to lineDiscountType: a percent when "percent", otherwise an absolute amount in minor currency units (paise).

lineSurchargeValue

required

integer

Line surcharge value. Interpreted according to lineSurchargeType: a percent when "percent", otherwise an absolute amount in minor currency units (paise).

required

array<object>

conditionNetPart

required

number

Line's share of invoice-level conditions applied to the net amount (decimal, e.g. 0.000000).

conditionGrossPart

required

number

Line's share of invoice-level conditions applied to the gross amount (decimal, e.g. 0.000000).

lineDiscountType

required

string

How lineDiscountValue is interpreted: "percent" or "constant" (absolute amount).

"percent"
"constant"

lineSurchargeType

required

string

How lineSurchargeValue is interpreted: "percent" or "constant" (absolute amount).

"percent"
"constant"

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",
      "conditions": [
        {
          "kind": "AMOUNT",
          "rate": null,
          "type": "REBATE",
          "basis": "NET",
          "amount": {
            "cents": 56988,
            "currency": "INR"
          },
          "position": 2
        }
      ],
      "attachments": [
        {
          "name": "1252_Invoice_With_Buyer_altkatest261002-7-wrongqty.pdf",
          "path": "supplier-invoices/1252_01a0fbcb-ef81-7079-b827-af158719b3f2.pdf",
          "type": "ORIGINAL",
          "timestamp": null
        }
      ]
    },
    "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",
        "priceUnitQty": 1,
        "lineDiscountValue": 0,
        "lineSurchargeValue": 0,
        "taxes": [
          {
            "rate": 0.09,
            "amount": {
              "cents": 45957,
              "currency": "INR"
            },
            "taxCode": "CGST"
          },
          {
            "rate": 0.09,
            "amount": {
              "cents": 45957,
              "currency": "INR"
            },
            "taxCode": "SGST"
          }
        ],
        "conditionNetPart": 0,
        "conditionGrossPart": 0,
        "lineDiscountType": "percent",
        "lineSurchargeType": "percent"
      },
      {
        "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,
        "priceUnitQty": 1,
        "lineDiscountValue": 0,
        "lineSurchargeValue": 0,
        "taxes": [
          {
            "rate": 0.09,
            "amount": {
              "cents": 292,
              "currency": "INR"
            },
            "taxCode": "CGST"
          },
          {
            "rate": 0.09,
            "amount": {
              "cents": 292,
              "currency": "INR"
            },
            "taxCode": "SGST"
          }
        ],
        "conditionNetPart": 0,
        "conditionGrossPart": 0,
        "lineDiscountType": "percent",
        "lineSurchargeType": "percent"
      }
    ]
  }
}

SEND erp.invoicing.events

Channel carrying all invoicing domain events from ERP.

ERP publishes InvoiceWasDeleted when an invoice is deleted.

Operation IDpublishInvoiceWasDeleted

Accepts the following message:

Invoice Was DeletedInvoiceWasDeleted

Identifier of an invoice emitted after it has been deleted.

application/json

Message IDInvoiceWasDeleted

allOf

Examples

#1 Example - deleted-invoice-example

Envelope carrying the identifier of a deleted invoice

{
  "specVersion": "1",
  "messageId": "5d4c3b2a-1f0e-4d9c-8b7a-6f5e4d3c2b1a",
  "eventType": "InvoiceWasDeleted",
  "eventVersion": 1,
  "producer": "erp",
  "occurredAt": "2026-10-16T06:00:00Z",
  "aggregateType": "Invoice",
  "aggregateId": "01a0f2e4-17e5-7192-beb1-88096f9fbefd",
  "payload": {
    "id": "01a0f2e4-17e5-7192-beb1-88096f9fbefd"
  }
}

SEND erp.invoicing.events

Channel carrying all invoicing domain events from ERP.

ERP publishes InvoiceItemAllocationsChanged when an invoice item's allocations to purchase order items change.

Operation IDpublishInvoiceItemAllocationsChanged

Accepts the following message:

Invoice Item Allocations ChangedInvoiceItemAllocationsChanged

Current set of allocations of an invoice item to purchase order items.

application/json

Message IDInvoiceItemAllocationsChanged

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.

object

Examples

#1 Example - invoice-item-allocations-changed-example

Envelope carrying an invoice item allocated across two purchase order items

{
  "specVersion": "1",
  "messageId": "2b1c4d6e-7f8a-4b9c-8d0e-1f2a3b4c5d6e",
  "eventType": "InvoiceItemAllocationsChanged",
  "eventVersion": 1,
  "producer": "erp",
  "occurredAt": "2026-09-30T15:40:42Z",
  "aggregateType": "InvoiceItem",
  "aggregateId": "01a0f2e4-1939-70c5-ab9a-fc08ee015b98",
  "payload": {
    "invoiceItemId": "01a0f2e4-1939-70c5-ab9a-fc08ee015b98",
    "allocations": [
      {
        "purchaseItemId": "01a0f2e4-2a71-7b3c-8d9e-10f2a3b4c5d6",
        "qty": 3
      },
      {
        "purchaseItemId": "01a0f2e4-3b82-7c4d-9e0f-21a3b4c5d6e7",
        "qty": 5
      }
    ]
  }
}

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.

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

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

string

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.

required

array<object>

required

array<object>

Additional properties are NOT allowed.

required

array<object>

Invoice line items.

object

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

number

>= 0

Invoiced quantity (decimal, e.g. 1.000000).

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.

priceUnitQty

required

integer

Price unit quantity: number of units the net price refers to (e.g. 1 = price per 1 unit).

lineDiscountValue

required

integer

Line discount value. Interpreted according to lineDiscountType: a percent when "percent", otherwise an absolute amount in minor currency units (paise).

lineSurchargeValue

required

integer

Line surcharge value. Interpreted according to lineSurchargeType: a percent when "percent", otherwise an absolute amount in minor currency units (paise).

required

array<object>

conditionNetPart

required

number

Line's share of invoice-level conditions applied to the net amount (decimal, e.g. 0.000000).

conditionGrossPart

required

number

Line's share of invoice-level conditions applied to the gross amount (decimal, e.g. 0.000000).

lineDiscountType

required

string

How lineDiscountValue is interpreted: "percent" or "constant" (absolute amount).

"percent"
"constant"

lineSurchargeType

required

string

How lineSurchargeValue is interpreted: "percent" or "constant" (absolute amount).

"percent"
"constant"

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.

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

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

string

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.

required

array<object>

required

array<object>

Additional properties are NOT allowed.

required

array<object>

Invoice line items.

object

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

number

>= 0

Invoiced quantity (decimal, e.g. 1.000000).

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.

priceUnitQty

required

integer

Price unit quantity: number of units the net price refers to (e.g. 1 = price per 1 unit).

lineDiscountValue

required

integer

Line discount value. Interpreted according to lineDiscountType: a percent when "percent", otherwise an absolute amount in minor currency units (paise).

lineSurchargeValue

required

integer

Line surcharge value. Interpreted according to lineSurchargeType: a percent when "percent", otherwise an absolute amount in minor currency units (paise).

required

array<object>

conditionNetPart

required

number

Line's share of invoice-level conditions applied to the net amount (decimal, e.g. 0.000000).

conditionGrossPart

required

number

Line's share of invoice-level conditions applied to the gross amount (decimal, e.g. 0.000000).

lineDiscountType

required

string

How lineDiscountValue is interpreted: "percent" or "constant" (absolute amount).

"percent"
"constant"

lineSurchargeType

required

string

How lineSurchargeValue is interpreted: "percent" or "constant" (absolute amount).

"percent"
"constant"

Additional properties are NOT allowed.

Additional properties are allowed.

#3Invoice Was DeletedInvoiceWasDeleted

Identifier of an invoice emitted after it has been deleted.

application/json

Message IDInvoiceWasDeleted

allOf

#4Invoice Item Allocations ChangedInvoiceItemAllocationsChanged

Current set of allocations of an invoice item to purchase order items.

application/json

Message IDInvoiceItemAllocationsChanged

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.

object