Back to Invoice
INV1.0.8
Invoice Example
Approved canonical example from the published Invoice JSON Schema. Use Preview to see schema fields alongside example values, or Code for the canonical JSON payload.
| Field | Required | Description | Example value |
|---|---|---|---|
docType | Yes | Canonical document type. For invoices this value is INV. | INV |
correlationId | Yes | Stable UUID used to trace this invoice through order, shipment, and payment workflows. | 43e7580b-e592-46bb-a3d0-dbf8997758d9 |
timestamp | Yes | UTC timestamp indicating when DataShift created the canonical invoice. | 2026-05-16T04:00:00Z |
metadata.sourceLanguage | Yes | cxml | |
metadata.sourceVersion | Yes | Canonical schema version used to create this document | 1.0.8 |
metadata.payloadId | No | Original cXML payload ID | inv-example-10001 |
metadata.userAgent | Yes | DataShift Edge version that generated the canonical document | DataShift Edge v1 |
data.invoiceNumber | Yes | Supplier-generated invoice number. | INV-10001 |
data.poNumber | Yes | Primary purchase order number this invoice bills against. | PO-10001 |
data.invoiceDate | Yes | Date and time the supplier issued the invoice. | 2026-05-16T04:00:00Z |
data.dueDate | No | Payment due date. | 2026-06-15T00:00:00Z |
data.purpose | Yes | Invoice business purpose. | standard |
data.operation | No | Whether this creates, updates, or deletes an invoice | - |
data.invoiceOrigin | No | Whether invoice was originated by supplier or buyer (ERS) | - |
data.isInformationOnly | No | If true, invoice is for information only and no action required | - |
data.isERS | No | Evaluated Receipt Settlement invoice | - |
data.documentReference.invoiceId | No | - | |
data.documentReference.invoiceDate | No | - | |
data.documentReference.documentId | No | - | |
data.documentReference.payloadId | No | - | |
data.poReferences[].poNumber | Yes | PO-10001 | |
data.poReferences[].poVersion | No | 1 | |
data.poReferences[].documentId | No | - | |
data.poReferences[].payloadId | No | - | |
data.poReferences[].orderDate | No | - | |
data.asnReference.shipmentId | No | - | |
data.asnReference.shipmentDate | No | - | |
data.asnReference.documentId | No | - | |
data.asnReference.payloadId | No | - | |
data.supplier.id | Yes | SUPPLIER-AU | |
data.supplier.name | Yes | Example Supplier Pty Ltd | |
data.supplier.taxRegistrations.type | Yes | ABN | |
data.supplier.taxRegistrations.value | Yes | 98765432109 | |
data.supplier.contact.name | No | - | |
data.supplier.contact.phone | No | - | |
data.supplier.contact.email | No | - | |
data.supplier.contact.role | No | - | |
data.supplier.address.addressId | No | - | |
data.supplier.address.addressee | No | Example Supplier Pty Ltd | |
data.supplier.address.street1 | Yes | 20 Supplier Street | |
data.supplier.address.street2 | No | - | |
data.supplier.address.city | Yes | Adelaide | |
data.supplier.address.state | Yes | SA | |
data.supplier.address.postalCode | Yes | 5000 | |
data.supplier.address.country | Yes | AU | |
data.billTo.addressId | No | - | |
data.billTo.addressee | No | Example Buyer Accounts | |
data.billTo.street1 | Yes | 1 Market Street | |
data.billTo.street2 | No | - | |
data.billTo.city | Yes | Sydney | |
data.billTo.state | Yes | NSW | |
data.billTo.postalCode | Yes | 2000 | |
data.billTo.country | Yes | AU | |
data.soldTo | No | Sold-to party (may differ from bill-to) | - |
data.shipTo.addressId | No | - | |
data.shipTo.addressee | No | - | |
data.shipTo.street1 | Yes | - | |
data.shipTo.street2 | No | - | |
data.shipTo.city | Yes | - | |
data.shipTo.state | Yes | - | |
data.shipTo.postalCode | Yes | - | |
data.shipTo.country | Yes | - | |
data.remitTo.addressId | No | - | |
data.remitTo.addressee | No | - | |
data.remitTo.street1 | No | - | |
data.remitTo.street2 | No | - | |
data.remitTo.city | No | - | |
data.remitTo.state | No | - | |
data.remitTo.postalCode | No | - | |
data.remitTo.country | No | - | |
data.remitTo.bankDetails.bankName | No | - | |
data.remitTo.bankDetails.accountName | No | - | |
data.remitTo.bankDetails.accountNumber | No | - | |
data.remitTo.bankDetails.bsb | No | - | |
data.remitTo.bankDetails.swift | No | - | |
data.remitTo.bankDetails.iban | No | - | |
data.shipping.amount | No | - | |
data.shipping.currency | No | ISO 4217 currency codes supported by DataShift canonical schemas | - |
data.shipping.carrier | No | - | |
data.shipping.route | No | - | |
data.shipping.shippingInstructions | No | - | |
data.shipping.buyerAcctNumber | No | - | |
data.shipping.incoTerms | No | - | |
data.shipmentDetails.carrier | No | - | |
data.shipmentDetails.trackingNumber | No | - | |
data.shipmentDetails.shippingDate | No | - | |
data.paymentTerms.description | No | Human-readable payment terms (e.g., 'Net 30', '2/10 Net 30') | - |
data.paymentTerms.netDays | No | Number of days until payment is due | - |
data.paymentTerms.discountTerms[].discountPercent | No | Discount percentage (e.g., 2 for 2%) | - |
data.paymentTerms.discountTerms[].discountDays | No | Days within which discount applies | - |
data.paymentTerms.discountTerms[].discountDueDate | No | Specific date by which discount applies | - |
data.contacts[].role | Yes | - | |
data.contacts[].name | No | - | |
data.contacts[].email | No | - | |
data.contacts[].phone | No | - | |
data.comments | No | Invoice-level comments or notes | - |
data.lineItems[].invoiceLineNumber | Yes | Supplier's line number for this invoice line. | 1 |
data.lineItems[].uniqueLineKey | No | DataShift-managed stable line key from the original purchase order. | PO-10001-1 |
data.lineItems[].poLineReference | No | Line number from the purchase order being invoiced. | 1 |
data.lineItems[].asnLineReference | No | Line number from the ship notice | - |
data.lineItems[].supplierItemId | No | Supplier's part/item number | SUP-001 |
data.lineItems[].buyerItemId | No | Buyer's part/item number | BUY-001 |
data.lineItems[].description | No | Item description | Example product |
data.lineItems[].quantity | Yes | Quantity invoiced. | 12 |
data.lineItems[].unitOfMeasure | No | UN/ECE Recommendation 20 unit of measure codes for DataShift canonical documents | EA |
data.lineItems[].unitPrice | Yes | Unit price | 25 |
data.lineItems[].subtotal | Yes | Line subtotal before tax and adjustments. | 300 |
data.lineItems[].taxAmount | No | Tax amount for this line | 30 |
data.lineItems[].taxRate | No | Tax rate as percentage (e.g., 10 for 10%) | - |
data.lineItems[].discountAmount | No | Discount amount for this line | - |
data.lineItems[].shippingAmount | No | Shipping charge for this line | - |
data.lineItems[].grossAmount | No | Subtotal + tax + shipping before discounts | - |
data.lineItems[].netAmount | No | Gross amount minus discounts | - |
data.lineItems[].currency | Yes | ISO 4217 currency code for this line. | AUD |
data.lineItems[].manufacturerPartId | No | Manufacturer's part number | - |
data.lineItems[].manufacturerName | No | Manufacturer name | - |
data.lineItems[].countryOfOrigin | No | Country where item was manufactured | - |
data.lineItems[].serialNumbers | No | Serial numbers for serialized items | - |
data.lineItems[].batchId | No | Lot/batch ID | - |
data.lineItems[].classification[].domain | No | Classification scheme | - |
data.lineItems[].classification[].code | No | - | |
data.lineItems[].comments | No | Line-level comments | - |
data.invoiceSummary.shippingAmount | No | Total shipping charges | - |
data.invoiceSummary.specialHandlingAmount | No | Special handling charges | - |
data.invoiceSummary.taxAmount | Yes | Total tax amount | 30 |
data.invoiceSummary.taxBreakdown[].taxType | No | Type of tax | - |
data.invoiceSummary.taxBreakdown[].taxRate | No | Tax rate as percentage | - |
data.invoiceSummary.taxBreakdown[].taxableAmount | No | Amount subject to this tax | - |
data.invoiceSummary.taxBreakdown[].taxAmount | No | Calculated tax amount | - |
data.invoiceSummary.taxBreakdown[].jurisdiction | No | Tax jurisdiction (e.g., state, country) | - |
data.invoiceSummary.taxBreakdown[].description | No | - | |
data.invoiceSummary.discountAmount | No | Total discount amount | - |
data.invoiceSummary.grossAmount | No | Subtotal + tax + shipping + handling before discounts | 330 |
data.invoiceSummary.netAmount | No | Gross amount minus discounts | 330 |
data.invoiceSummary.depositAmount | No | Prepayment/deposit already received | - |
data.invoiceSummary.dueAmount | Yes | Amount due (net - deposits) | 330 |
data.invoiceSummary.currency | Yes | ISO 4217 currency codes supported by DataShift canonical schemas | AUD |
data.extrinsics | No | Partner-specific extension fields that are not part of the canonical core contract. | {"accountsReference":"AP-10001"} |