Skip to main content
The InvoiceItem resource represents a line item in a document such as an invoice or quote. Each item includes pricing, quantity, period, taxation, and descriptive data for clarity and downstream processing.

​
Main fields

NameTypeRequiredConstraintsAllowed ValuesDescriptionExample
line_idstring✅ Yesunique within document–Line item identifier”1”
skustring⚪ No––Stock Keeping Unit or internal reference code”WM-1001”
namestring✅ Yes––Name of the product or service”Wireless Mouse”
descriptionstring⚪ No––Description of the item”Ergonomic wireless mouse with USB receiver”
unit_pricenumber✅ Yes>= 0–Price per unit in the document currency25.00
currencystring (ISO 4217)⚪ No3-letter codeEUR, USD, GBP, etc.Overrides document-level currency if present”EUR”
unitstring⚪ No–EA, HOUR, KG, etc.Measurement unit for the item”EA”
min_quantitynumber⚪ No>= 0–Minimum order quantity1
max_quantitynumber⚪ No>= min_quantity–Maximum allowed quantity500
tax.ratenumber⚪ No0–100–Applicable tax rate in percent20.0
tax.categorystring⚪ No–standard, reduced, exemptTaxation category code”standard”
tax.schemestring⚪ No–VAT, GST, sales_taxThe tax regime used”VAT”
period.startstring (ISO 8601)⚪ Nodate format–Start of usage/billing period”2025-06-26”
period.endstring (ISO 8601)⚪ Nodate format–End of usage/billing period”2025-06-27”
created_atstring (ISO 8601) 🔒 system–auto timestamp–Creation timestamp”2025-05-11T13:42:12Z”
updated_atstring (ISO 8601) 🔒 system–auto timestamp–Last updated timestamp”2025-05-11T13:45:20Z”
deleted_atstring | null 🔒 system⚪ Nonullable ISO 8601–Deletion timestamp (soft delete)""

​
Relations

​
Relationships Table

NameTypeRequiredExample
invoicesto-many (invoices)✅ Yes “type”: “invoices”, “id”: “invoice-1”
mediasto-many⚪ No “type”: “media”, “id”: “media-1”
workspacesto-many (categories)⚪ No

​
Validation & UX Notes

  • 🟥 Required fields: line_id, name, unit_price
  • ⚪ Use sku and description for richer context but not required
  • 📌 If currency differs from document-level, conversion logic may apply at total aggregation level
  • ⚠️ tax.rate, category, and scheme are optional but recommended for invoice compliance
  • 💡 min_quantity and max_quantity are helpful for quoting scenarios or CPQ systems
  • 🧪 Draft behavior supports missing fields for unconfirmed item lines

​
Audit & System Fields

🔒 id is assigned automatically by the system and immutable
💡 If currency is omitted, the document’s currency will apply by default
📌 All date/timestamps follow ISO 8601 format (UTC)
⌘I