Back to Invoice 1.0.8 Latest
/edi/contracts/releases/1.0.8/schemas/invoice.schema.json View Hide Schema
invoice.schema.json
docType docTypeconstant
Required Canonical document type. For invoices this value is INV. correlationId correlationIdstring
Required Stable UUID used to trace this invoice through order, shipment, and payment workflows. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical invoice. metadata metadataobject
Required Public source metadata retained for integration troubleshooting. sourceLanguage metadata.sourceLanguagestring
Required Values: json, cxml sourceVersion metadata.sourceVersionconstant
Required Canonical schema version used to create this document payloadId metadata.payloadIdstring
Original cXML payload ID userAgent metadata.userAgentconstant
Required DataShift Edge version that generated the canonical document data dataobject
Required Business payload for the invoice. invoiceNumber data.invoiceNumberstring
Required Supplier-generated invoice number. poNumber data.poNumberstring
Required Primary purchase order number this invoice bills against. invoiceDate data.invoiceDatestring
Required Date and time the supplier issued the invoice. dueDate data.dueDatestring
Payment due date. purpose data.purposestring
Required Invoice business purpose. Values: standard, creditMemo, debitMemo, lineLevelCreditMemo, lineLevelDebitMemo operation data.operationstring
Whether this creates, updates, or deletes an invoice Values: new, update, delete invoiceOrigin data.invoiceOriginstring
Whether invoice was originated by supplier or buyer (ERS) Values: supplier, buyer isInformationOnly data.isInformationOnlyboolean
If true, invoice is for information only and no action required isERS data.isERSboolean
Evaluated Receipt Settlement invoice documentReference data.documentReferenceobject
Reference to previous invoice (for credit/debit memos or cancellations) invoiceId data.documentReference.invoiceIdstring
invoiceDate data.documentReference.invoiceDatestring
documentId data.documentReference.documentIdstring
payloadId data.documentReference.payloadIdstring
poReferences data.poReferencesarray
Purchase orders being invoiced. poNumber data.poReferences[].poNumberstring
poVersion data.poReferences[].poVersionstring
documentId data.poReferences[].documentIdstring
payloadId data.poReferences[].payloadIdstring
orderDate data.poReferences[].orderDatestring
asnReference data.asnReferenceobject
Shipment notice reference when invoicing against a dispatched shipment. shipmentId data.asnReference.shipmentIdstring
shipmentDate data.asnReference.shipmentDatestring
documentId data.asnReference.documentIdstring
payloadId data.asnReference.payloadIdstring
supplier data.supplierobject
Required Supplier or seller issuing the invoice. id data.supplier.idstring
Required name data.supplier.namestring
Required taxRegistrations data.supplier.taxRegistrationsobject
Australian tax registrations for the party type data.supplier.taxRegistrations.typestring
Required Values: ABN value data.supplier.taxRegistrations.valuestring
Required contact data.supplier.contactobject
name data.supplier.contact.namestring
phone data.supplier.contact.phonestring
email data.supplier.contact.emailstring
role data.supplier.contact.rolestring
address data.supplier.addressobject
Standard address structure for DataShift canonical documents addressId data.supplier.address.addressIdstring
addressee data.supplier.address.addresseestring
street1 data.supplier.address.street1string
Required street2 data.supplier.address.street2string
city data.supplier.address.citystring
Required state data.supplier.address.statestring
Required postalCode data.supplier.address.postalCodestring
Required country data.supplier.address.countrystring
Required Values: AU billTo data.billToobject
Required Buyer billing party. addressId data.billTo.addressIdstring
addressee data.billTo.addresseestring
street1 data.billTo.street1string
Required street2 data.billTo.street2string
city data.billTo.citystring
Required state data.billTo.statestring
Required postalCode data.billTo.postalCodestring
Required country data.billTo.countrystring
Required Values: AU soldTo data.soldTounknown
Sold-to party (may differ from bill-to) shipTo data.shipToobject
Standard address structure for DataShift canonical documents addressId data.shipTo.addressIdstring
addressee data.shipTo.addresseestring
street1 data.shipTo.street1string
Required street2 data.shipTo.street2string
city data.shipTo.citystring
Required state data.shipTo.statestring
Required postalCode data.shipTo.postalCodestring
Required country data.shipTo.countrystring
Required Values: AU remitTo data.remitToobject
Address where payment should be sent addressId data.remitTo.addressIdstring
addressee data.remitTo.addresseestring
street1 data.remitTo.street1string
street2 data.remitTo.street2string
city data.remitTo.citystring
state data.remitTo.statestring
postalCode data.remitTo.postalCodestring
country data.remitTo.countrystring
Values: AU bankDetails data.remitTo.bankDetailsobject
bankName data.remitTo.bankDetails.bankNamestring
accountName data.remitTo.bankDetails.accountNamestring
accountNumber data.remitTo.bankDetails.accountNumberstring
bsb data.remitTo.bankDetails.bsbstring
swift data.remitTo.bankDetails.swiftstring
iban data.remitTo.bankDetails.ibanstring
shipping data.shippingobject
Commercial freight charges and instructions for the invoice. amount data.shipping.amountnumber
currency data.shipping.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD carrier data.shipping.carrierstring
route data.shipping.routestring
shippingInstructions data.shipping.shippingInstructionsstring
buyerAcctNumber data.shipping.buyerAcctNumberstring
incoTerms data.shipping.incoTermsstring
Values: cfr, cif, cip, cpt, daf, dap (+9 more) shipmentDetails data.shipmentDetailsobject
Actual dispatch and tracking information for the invoiced goods carrier data.shipmentDetails.carrierstring
trackingNumber data.shipmentDetails.trackingNumberstring
shippingDate data.shipmentDetails.shippingDatestring
paymentTerms data.paymentTermsobject
Payment terms and conditions description data.paymentTerms.descriptionstring
Human-readable payment terms (e.g., 'Net 30', '2/10 Net 30') netDays data.paymentTerms.netDaysinteger
Number of days until payment is due discountTerms data.paymentTerms.discountTermsarray
Early payment discount tiers discountPercent data.paymentTerms.discountTerms[].discountPercentnumber
Discount percentage (e.g., 2 for 2%) discountDays data.paymentTerms.discountTerms[].discountDaysinteger
Days within which discount applies discountDueDate data.paymentTerms.discountTerms[].discountDueDatestring
Specific date by which discount applies contacts data.contactsarray
Contact information for various roles role data.contacts[].rolestring
Values: issuerOfInvoice, soldTo, billTo, remitTo, shipFrom, shipTo name data.contacts[].namestring
email data.contacts[].emailstring
phone data.contacts[].phonestring
comments data.commentsstring
Invoice-level comments or notes lineItems data.lineItemsarray
Required Invoice lines. DataShift manages uniqueLineKey correlation back to PO and ASN lines where needed. invoiceLineNumber data.lineItems[].invoiceLineNumberinteger
Supplier's line number for this invoice line. uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key from the original purchase order. poLineReference data.lineItems[].poLineReferenceinteger
Line number from the purchase order being invoiced. asnLineReference data.lineItems[].asnLineReferenceinteger
Line number from the ship notice supplierItemId data.lineItems[].supplierItemIdstring
Supplier's part/item number buyerItemId data.lineItems[].buyerItemIdstring
Buyer's part/item number description data.lineItems[].descriptionstring
Item description quantity data.lineItems[].quantitynumber
Quantity invoiced. unitOfMeasure data.lineItems[].unitOfMeasurestring
UN/ECE Recommendation 20 unit of measure codes for DataShift canonical documents Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].unitPricenumber
Unit price subtotal data.lineItems[].subtotalnumber
Line subtotal before tax and adjustments. taxAmount data.lineItems[].taxAmountnumber
Tax amount for this line taxRate data.lineItems[].taxRatenumber
Tax rate as percentage (e.g., 10 for 10%) discountAmount data.lineItems[].discountAmountnumber
Discount amount for this line shippingAmount data.lineItems[].shippingAmountnumber
Shipping charge for this line grossAmount data.lineItems[].grossAmountnumber
Subtotal + tax + shipping before discounts netAmount data.lineItems[].netAmountnumber
Gross amount minus discounts currency data.lineItems[].currencystring
ISO 4217 currency code for this line. Values: AUD manufacturerPartId data.lineItems[].manufacturerPartIdstring
Manufacturer's part number manufacturerName data.lineItems[].manufacturerNamestring
Manufacturer name countryOfOrigin data.lineItems[].countryOfOriginstring
Country where item was manufactured Values: AU serialNumbers data.lineItems[].serialNumbersarray
Serial numbers for serialized items batchId data.lineItems[].batchIdstring
Lot/batch ID classification data.lineItems[].classificationarray
Product classification codes domain data.lineItems[].classification[].domainstring
Classification scheme Values: UNSPSC, HS, commodity code data.lineItems[].classification[].codestring
comments data.lineItems[].commentsstring
Line-level comments invoiceSummary data.invoiceSummaryobject
Required Invoice totals, tax, discounts, and amount due. shippingAmount data.invoiceSummary.shippingAmountnumber
Total shipping charges specialHandlingAmount data.invoiceSummary.specialHandlingAmountnumber
Special handling charges taxAmount data.invoiceSummary.taxAmountnumber
Required Total tax amount taxBreakdown data.invoiceSummary.taxBreakdownarray
Tax breakdown by type/jurisdiction taxType data.invoiceSummary.taxBreakdown[].taxTypestring
Type of tax Values: GST, VAT, salesTax, excise, other taxRate data.invoiceSummary.taxBreakdown[].taxRatenumber
Tax rate as percentage taxableAmount data.invoiceSummary.taxBreakdown[].taxableAmountnumber
Amount subject to this tax taxAmount data.invoiceSummary.taxBreakdown[].taxAmountnumber
Calculated tax amount jurisdiction data.invoiceSummary.taxBreakdown[].jurisdictionstring
Tax jurisdiction (e.g., state, country) description data.invoiceSummary.taxBreakdown[].descriptionstring
discountAmount data.invoiceSummary.discountAmountnumber
Total discount amount grossAmount data.invoiceSummary.grossAmountnumber
Subtotal + tax + shipping + handling before discounts netAmount data.invoiceSummary.netAmountnumber
Gross amount minus discounts depositAmount data.invoiceSummary.depositAmountnumber
Prepayment/deposit already received dueAmount data.invoiceSummary.dueAmountnumber
Required Amount due (net - deposits) currency data.invoiceSummary.currencystring
Required ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD extrinsics data.extrinsicsobject
Partner-specific extension fields that are not part of the canonical core contract. 1.0.7
/edi/contracts/releases/1.0.7/schemas/invoice.schema.json View Hide Schema
invoice.schema.json
docType docTypeconstant
Required Canonical document type. For invoices this value is INV. correlationId correlationIdstring
Required Stable UUID used to trace this invoice through order, shipment, and payment workflows. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical invoice. metadata metadataobject
Required Public source metadata retained for integration troubleshooting. sourceLanguage metadata.sourceLanguagestring
Required Values: json, cxml sourceVersion metadata.sourceVersionstring
Required payloadId metadata.payloadIdstring
Original cXML payload ID userAgent metadata.userAgentstring
Required System that generated the document data dataobject
Required Business payload for the invoice. invoiceNumber data.invoiceNumberstring
Required Supplier-generated invoice number. poNumber data.poNumberstring
Required Primary purchase order number this invoice bills against. invoiceDate data.invoiceDatestring
Required Date and time the supplier issued the invoice. dueDate data.dueDatestring
Payment due date. purpose data.purposestring
Required Invoice business purpose. Values: standard, creditMemo, debitMemo, lineLevelCreditMemo, lineLevelDebitMemo operation data.operationstring
Whether this creates, updates, or deletes an invoice Values: new, update, delete invoiceOrigin data.invoiceOriginstring
Whether invoice was originated by supplier or buyer (ERS) Values: supplier, buyer isInformationOnly data.isInformationOnlyboolean
If true, invoice is for information only and no action required isERS data.isERSboolean
Evaluated Receipt Settlement invoice documentReference data.documentReferenceobject
Reference to previous invoice (for credit/debit memos or cancellations) invoiceId data.documentReference.invoiceIdstring
invoiceDate data.documentReference.invoiceDatestring
documentId data.documentReference.documentIdstring
payloadId data.documentReference.payloadIdstring
poReferences data.poReferencesarray
Purchase orders being invoiced. poNumber data.poReferences[].poNumberstring
poVersion data.poReferences[].poVersionstring
documentId data.poReferences[].documentIdstring
payloadId data.poReferences[].payloadIdstring
orderDate data.poReferences[].orderDatestring
asnReference data.asnReferenceobject
Shipment notice reference when invoicing against a dispatched shipment. shipmentId data.asnReference.shipmentIdstring
shipmentDate data.asnReference.shipmentDatestring
documentId data.asnReference.documentIdstring
payloadId data.asnReference.payloadIdstring
supplier data.supplierobject
Required Supplier or seller issuing the invoice. id data.supplier.idstring
Required name data.supplier.namestring
Required taxRegistrations data.supplier.taxRegistrationsobject
Australian tax registrations for the party type data.supplier.taxRegistrations.typestring
Required Values: ABN value data.supplier.taxRegistrations.valuestring
Required contact data.supplier.contactobject
name data.supplier.contact.namestring
phone data.supplier.contact.phonestring
email data.supplier.contact.emailstring
role data.supplier.contact.rolestring
address data.supplier.addressobject
Standard address structure for DataShift canonical documents addressId data.supplier.address.addressIdstring
addressee data.supplier.address.addresseestring
street1 data.supplier.address.street1string
Required street2 data.supplier.address.street2string
city data.supplier.address.citystring
Required state data.supplier.address.statestring
Required postalCode data.supplier.address.postalCodestring
Required country data.supplier.address.countrystring
Required Values: AU billTo data.billToobject
Required Buyer billing party. addressId data.billTo.addressIdstring
addressee data.billTo.addresseestring
street1 data.billTo.street1string
Required street2 data.billTo.street2string
city data.billTo.citystring
Required state data.billTo.statestring
Required postalCode data.billTo.postalCodestring
Required country data.billTo.countrystring
Required Values: AU soldTo data.soldTounknown
Sold-to party (may differ from bill-to) shipTo data.shipToobject
Standard address structure for DataShift canonical documents addressId data.shipTo.addressIdstring
addressee data.shipTo.addresseestring
street1 data.shipTo.street1string
Required street2 data.shipTo.street2string
city data.shipTo.citystring
Required state data.shipTo.statestring
Required postalCode data.shipTo.postalCodestring
Required country data.shipTo.countrystring
Required Values: AU remitTo data.remitToobject
Address where payment should be sent addressId data.remitTo.addressIdstring
addressee data.remitTo.addresseestring
street1 data.remitTo.street1string
street2 data.remitTo.street2string
city data.remitTo.citystring
state data.remitTo.statestring
postalCode data.remitTo.postalCodestring
country data.remitTo.countrystring
Values: AU bankDetails data.remitTo.bankDetailsobject
bankName data.remitTo.bankDetails.bankNamestring
accountName data.remitTo.bankDetails.accountNamestring
accountNumber data.remitTo.bankDetails.accountNumberstring
bsb data.remitTo.bankDetails.bsbstring
swift data.remitTo.bankDetails.swiftstring
iban data.remitTo.bankDetails.ibanstring
shipping data.shippingobject
Commercial freight charges and instructions for the invoice. amount data.shipping.amountnumber
currency data.shipping.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD carrier data.shipping.carrierstring
route data.shipping.routestring
shippingInstructions data.shipping.shippingInstructionsstring
buyerAcctNumber data.shipping.buyerAcctNumberstring
incoTerms data.shipping.incoTermsstring
Values: cfr, cif, cip, cpt, daf, dap (+9 more) shipmentDetails data.shipmentDetailsobject
Actual dispatch and tracking information for the invoiced goods carrier data.shipmentDetails.carrierstring
trackingNumber data.shipmentDetails.trackingNumberstring
shippingDate data.shipmentDetails.shippingDatestring
paymentTerms data.paymentTermsobject
Payment terms and conditions description data.paymentTerms.descriptionstring
Human-readable payment terms (e.g., 'Net 30', '2/10 Net 30') netDays data.paymentTerms.netDaysinteger
Number of days until payment is due discountTerms data.paymentTerms.discountTermsarray
Early payment discount tiers discountPercent data.paymentTerms.discountTerms[].discountPercentnumber
Discount percentage (e.g., 2 for 2%) discountDays data.paymentTerms.discountTerms[].discountDaysinteger
Days within which discount applies discountDueDate data.paymentTerms.discountTerms[].discountDueDatestring
Specific date by which discount applies contacts data.contactsarray
Contact information for various roles role data.contacts[].rolestring
Values: issuerOfInvoice, soldTo, billTo, remitTo, shipFrom, shipTo name data.contacts[].namestring
email data.contacts[].emailstring
phone data.contacts[].phonestring
comments data.commentsstring
Invoice-level comments or notes lineItems data.lineItemsarray
Required Invoice lines. DataShift manages uniqueLineKey correlation back to PO and ASN lines where needed. invoiceLineNumber data.lineItems[].invoiceLineNumberinteger
Supplier's line number for this invoice line. uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key from the original purchase order. poLineReference data.lineItems[].poLineReferenceinteger
Line number from the purchase order being invoiced. asnLineReference data.lineItems[].asnLineReferenceinteger
Line number from the ship notice supplierItemId data.lineItems[].supplierItemIdstring
Supplier's part/item number buyerItemId data.lineItems[].buyerItemIdstring
Buyer's part/item number description data.lineItems[].descriptionstring
Item description quantity data.lineItems[].quantitynumber
Quantity invoiced. unitOfMeasure data.lineItems[].unitOfMeasurestring
UN/ECE Recommendation 20 unit of measure codes for DataShift canonical documents Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].unitPricenumber
Unit price subtotal data.lineItems[].subtotalnumber
Line subtotal before tax and adjustments. taxAmount data.lineItems[].taxAmountnumber
Tax amount for this line taxRate data.lineItems[].taxRatenumber
Tax rate as percentage (e.g., 10 for 10%) discountAmount data.lineItems[].discountAmountnumber
Discount amount for this line shippingAmount data.lineItems[].shippingAmountnumber
Shipping charge for this line grossAmount data.lineItems[].grossAmountnumber
Subtotal + tax + shipping before discounts netAmount data.lineItems[].netAmountnumber
Gross amount minus discounts currency data.lineItems[].currencystring
ISO 4217 currency code for this line. Values: AUD manufacturerPartId data.lineItems[].manufacturerPartIdstring
Manufacturer's part number manufacturerName data.lineItems[].manufacturerNamestring
Manufacturer name countryOfOrigin data.lineItems[].countryOfOriginstring
Country where item was manufactured Values: AU serialNumbers data.lineItems[].serialNumbersarray
Serial numbers for serialized items batchId data.lineItems[].batchIdstring
Lot/batch ID classification data.lineItems[].classificationarray
Product classification codes domain data.lineItems[].classification[].domainstring
Classification scheme Values: UNSPSC, HS, commodity code data.lineItems[].classification[].codestring
comments data.lineItems[].commentsstring
Line-level comments invoiceSummary data.invoiceSummaryobject
Required Invoice totals, tax, discounts, and amount due. subtotal data.invoiceSummary.subtotalnumber
Required Sum of all line subtotals shippingAmount data.invoiceSummary.shippingAmountnumber
Total shipping charges specialHandlingAmount data.invoiceSummary.specialHandlingAmountnumber
Special handling charges taxAmount data.invoiceSummary.taxAmountnumber
Required Total tax amount taxBreakdown data.invoiceSummary.taxBreakdownarray
Tax breakdown by type/jurisdiction taxType data.invoiceSummary.taxBreakdown[].taxTypestring
Type of tax Values: GST, VAT, salesTax, excise, other taxRate data.invoiceSummary.taxBreakdown[].taxRatenumber
Tax rate as percentage taxableAmount data.invoiceSummary.taxBreakdown[].taxableAmountnumber
Amount subject to this tax taxAmount data.invoiceSummary.taxBreakdown[].taxAmountnumber
Calculated tax amount jurisdiction data.invoiceSummary.taxBreakdown[].jurisdictionstring
Tax jurisdiction (e.g., state, country) description data.invoiceSummary.taxBreakdown[].descriptionstring
discountAmount data.invoiceSummary.discountAmountnumber
Total discount amount grossAmount data.invoiceSummary.grossAmountnumber
Subtotal + tax + shipping + handling before discounts netAmount data.invoiceSummary.netAmountnumber
Gross amount minus discounts depositAmount data.invoiceSummary.depositAmountnumber
Prepayment/deposit already received dueAmount data.invoiceSummary.dueAmountnumber
Required Amount due (net - deposits) currency data.invoiceSummary.currencystring
Required ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD extrinsics data.extrinsicsobject
Partner-specific extension fields that are not part of the canonical core contract. 1.0.6
/edi/contracts/releases/1.0.6/schemas/invoice.schema.json View Hide Schema
invoice.schema.json
docType docTypeconstant
Required Canonical document type. For invoices this value is INV. correlationId correlationIdstring
Required Stable UUID used to trace this invoice through order, shipment, and payment workflows. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical invoice. metadata metadataobject
Required Public source metadata retained for integration troubleshooting. sourceLanguage metadata.sourceLanguagestring
Required Values: json, cxml sourceVersion metadata.sourceVersionstring
Required payloadId metadata.payloadIdstring
Original cXML payload ID userAgent metadata.userAgentstring
Required System that generated the document data dataobject
Required Business payload for the invoice. invoiceNumber data.invoiceNumberstring
Required Supplier-generated invoice number. poNumber data.poNumberstring
Required Primary purchase order number this invoice bills against. invoiceDate data.invoiceDatestring
Required Date and time the supplier issued the invoice. dueDate data.dueDatestring
Payment due date. purpose data.purposestring
Required Invoice business purpose. Values: standard, creditMemo, debitMemo, lineLevelCreditMemo, lineLevelDebitMemo operation data.operationstring
Whether this creates, updates, or deletes an invoice Values: new, update, delete invoiceOrigin data.invoiceOriginstring
Whether invoice was originated by supplier or buyer (ERS) Values: supplier, buyer isInformationOnly data.isInformationOnlyboolean
If true, invoice is for information only and no action required isERS data.isERSboolean
Evaluated Receipt Settlement invoice documentReference data.documentReferenceobject
Reference to previous invoice (for credit/debit memos or cancellations) invoiceId data.documentReference.invoiceIdstring
invoiceDate data.documentReference.invoiceDatestring
documentId data.documentReference.documentIdstring
payloadId data.documentReference.payloadIdstring
poReferences data.poReferencesarray
Purchase orders being invoiced. poNumber data.poReferences[].poNumberstring
poVersion data.poReferences[].poVersionstring
documentId data.poReferences[].documentIdstring
payloadId data.poReferences[].payloadIdstring
orderDate data.poReferences[].orderDatestring
asnReference data.asnReferenceobject
Shipment notice reference when invoicing against a dispatched shipment. shipmentId data.asnReference.shipmentIdstring
shipmentDate data.asnReference.shipmentDatestring
documentId data.asnReference.documentIdstring
payloadId data.asnReference.payloadIdstring
supplier data.supplierobject
Required Supplier or seller issuing the invoice. id data.supplier.idstring
Required name data.supplier.namestring
Required taxRegistrations data.supplier.taxRegistrationsobject
Australian tax registrations for the party type data.supplier.taxRegistrations.typestring
Required Values: ABN value data.supplier.taxRegistrations.valuestring
Required contact data.supplier.contactobject
name data.supplier.contact.namestring
phone data.supplier.contact.phonestring
email data.supplier.contact.emailstring
role data.supplier.contact.rolestring
address data.supplier.addressobject
Standard address structure for DataShift canonical documents addressId data.supplier.address.addressIdstring
addressee data.supplier.address.addresseestring
Required street1 data.supplier.address.street1string
Required street2 data.supplier.address.street2string
city data.supplier.address.citystring
Required state data.supplier.address.statestring
Required postalCode data.supplier.address.postalCodestring
Required country data.supplier.address.countrystring
Required Values: AU billTo data.billToobject
Required Buyer billing party. addressId data.billTo.addressIdstring
addressee data.billTo.addresseestring
Required street1 data.billTo.street1string
Required street2 data.billTo.street2string
city data.billTo.citystring
Required state data.billTo.statestring
Required postalCode data.billTo.postalCodestring
Required country data.billTo.countrystring
Required Values: AU soldTo data.soldTounknown
Sold-to party (may differ from bill-to) shipTo data.shipToobject
Standard address structure for DataShift canonical documents addressId data.shipTo.addressIdstring
addressee data.shipTo.addresseestring
Required street1 data.shipTo.street1string
Required street2 data.shipTo.street2string
city data.shipTo.citystring
Required state data.shipTo.statestring
Required postalCode data.shipTo.postalCodestring
Required country data.shipTo.countrystring
Required Values: AU remitTo data.remitToobject
Address where payment should be sent addressId data.remitTo.addressIdstring
addressee data.remitTo.addresseestring
street1 data.remitTo.street1string
street2 data.remitTo.street2string
city data.remitTo.citystring
state data.remitTo.statestring
postalCode data.remitTo.postalCodestring
country data.remitTo.countrystring
Values: AU bankDetails data.remitTo.bankDetailsobject
bankName data.remitTo.bankDetails.bankNamestring
accountName data.remitTo.bankDetails.accountNamestring
accountNumber data.remitTo.bankDetails.accountNumberstring
bsb data.remitTo.bankDetails.bsbstring
swift data.remitTo.bankDetails.swiftstring
iban data.remitTo.bankDetails.ibanstring
shipping data.shippingobject
Commercial freight charges and instructions for the invoice. amount data.shipping.amountnumber
currency data.shipping.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD carrier data.shipping.carrierstring
route data.shipping.routestring
shippingInstructions data.shipping.shippingInstructionsstring
buyerAcctNumber data.shipping.buyerAcctNumberstring
incoTerms data.shipping.incoTermsstring
Values: cfr, cif, cip, cpt, daf, dap (+9 more) shipmentDetails data.shipmentDetailsobject
Actual dispatch and tracking information for the invoiced goods carrier data.shipmentDetails.carrierstring
trackingNumber data.shipmentDetails.trackingNumberstring
shippingDate data.shipmentDetails.shippingDatestring
paymentTerms data.paymentTermsobject
Payment terms and conditions description data.paymentTerms.descriptionstring
Human-readable payment terms (e.g., 'Net 30', '2/10 Net 30') netDays data.paymentTerms.netDaysinteger
Number of days until payment is due discountTerms data.paymentTerms.discountTermsarray
Early payment discount tiers discountPercent data.paymentTerms.discountTerms[].discountPercentnumber
Discount percentage (e.g., 2 for 2%) discountDays data.paymentTerms.discountTerms[].discountDaysinteger
Days within which discount applies discountDueDate data.paymentTerms.discountTerms[].discountDueDatestring
Specific date by which discount applies contacts data.contactsarray
Contact information for various roles role data.contacts[].rolestring
Values: issuerOfInvoice, soldTo, billTo, remitTo, shipFrom, shipTo name data.contacts[].namestring
email data.contacts[].emailstring
phone data.contacts[].phonestring
comments data.commentsstring
Invoice-level comments or notes lineItems data.lineItemsarray
Required Invoice lines. DataShift manages uniqueLineKey correlation back to PO and ASN lines where needed. invoiceLineNumber data.lineItems[].invoiceLineNumberinteger
Supplier's line number for this invoice line. uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key from the original purchase order. poLineReference data.lineItems[].poLineReferenceinteger
Line number from the purchase order being invoiced. asnLineReference data.lineItems[].asnLineReferenceinteger
Line number from the ship notice supplierItemId data.lineItems[].supplierItemIdstring
Supplier's part/item number buyerItemId data.lineItems[].buyerItemIdstring
Buyer's part/item number description data.lineItems[].descriptionstring
Item description quantity data.lineItems[].quantitynumber
Quantity invoiced. unitOfMeasure data.lineItems[].unitOfMeasurestring
UN/ECE Recommendation 20 unit of measure codes for DataShift canonical documents Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].unitPricenumber
Unit price subtotal data.lineItems[].subtotalnumber
Line subtotal before tax and adjustments. taxAmount data.lineItems[].taxAmountnumber
Tax amount for this line taxRate data.lineItems[].taxRatenumber
Tax rate as percentage (e.g., 10 for 10%) discountAmount data.lineItems[].discountAmountnumber
Discount amount for this line shippingAmount data.lineItems[].shippingAmountnumber
Shipping charge for this line grossAmount data.lineItems[].grossAmountnumber
Subtotal + tax + shipping before discounts netAmount data.lineItems[].netAmountnumber
Gross amount minus discounts currency data.lineItems[].currencystring
ISO 4217 currency code for this line. Values: AUD manufacturerPartId data.lineItems[].manufacturerPartIdstring
Manufacturer's part number manufacturerName data.lineItems[].manufacturerNamestring
Manufacturer name countryOfOrigin data.lineItems[].countryOfOriginstring
Country where item was manufactured Values: AU serialNumbers data.lineItems[].serialNumbersarray
Serial numbers for serialized items batchId data.lineItems[].batchIdstring
Lot/batch ID classification data.lineItems[].classificationarray
Product classification codes domain data.lineItems[].classification[].domainstring
Classification scheme Values: UNSPSC, HS, commodity code data.lineItems[].classification[].codestring
comments data.lineItems[].commentsstring
Line-level comments invoiceSummary data.invoiceSummaryobject
Required Invoice totals, tax, discounts, and amount due. subtotal data.invoiceSummary.subtotalnumber
Required Sum of all line subtotals shippingAmount data.invoiceSummary.shippingAmountnumber
Total shipping charges specialHandlingAmount data.invoiceSummary.specialHandlingAmountnumber
Special handling charges taxAmount data.invoiceSummary.taxAmountnumber
Required Total tax amount taxBreakdown data.invoiceSummary.taxBreakdownarray
Tax breakdown by type/jurisdiction taxType data.invoiceSummary.taxBreakdown[].taxTypestring
Type of tax Values: GST, VAT, salesTax, excise, other taxRate data.invoiceSummary.taxBreakdown[].taxRatenumber
Tax rate as percentage taxableAmount data.invoiceSummary.taxBreakdown[].taxableAmountnumber
Amount subject to this tax taxAmount data.invoiceSummary.taxBreakdown[].taxAmountnumber
Calculated tax amount jurisdiction data.invoiceSummary.taxBreakdown[].jurisdictionstring
Tax jurisdiction (e.g., state, country) description data.invoiceSummary.taxBreakdown[].descriptionstring
discountAmount data.invoiceSummary.discountAmountnumber
Total discount amount grossAmount data.invoiceSummary.grossAmountnumber
Subtotal + tax + shipping + handling before discounts netAmount data.invoiceSummary.netAmountnumber
Gross amount minus discounts depositAmount data.invoiceSummary.depositAmountnumber
Prepayment/deposit already received dueAmount data.invoiceSummary.dueAmountnumber
Required Amount due (net - deposits) currency data.invoiceSummary.currencystring
Required ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD extrinsics data.extrinsicsobject
Partner-specific extension fields that are not part of the canonical core contract. 1.0.4
/edi/contracts/releases/1.0.4/schemas/invoice.schema.json View Hide Schema
invoice.schema.json
docType docTypeconstant
Required Canonical document type. For invoices this value is INV. correlationId correlationIdstring
Required Stable UUID used to trace this invoice through order, shipment, and payment workflows. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical invoice. metadata metadataobject
Required Public source metadata retained for integration troubleshooting. sourceLanguage metadata.sourceLanguagestring
Required Values: json, cxml sourceVersion metadata.sourceVersionstring
Required payloadId metadata.payloadIdstring
Original cXML payload ID userAgent metadata.userAgentstring
Required System that generated the document data dataobject
Required Business payload for the invoice. invoiceNumber data.invoiceNumberstring
Required Supplier-generated invoice number. poNumber data.poNumberstring
Required Primary purchase order number this invoice bills against. invoiceDate data.invoiceDatestring
Required Date and time the supplier issued the invoice. dueDate data.dueDatestring
Payment due date. purpose data.purposestring
Required Invoice business purpose. Values: standard, creditMemo, debitMemo, lineLevelCreditMemo, lineLevelDebitMemo operation data.operationstring
Whether this creates, updates, or deletes an invoice Values: new, update, delete invoiceOrigin data.invoiceOriginstring
Whether invoice was originated by supplier or buyer (ERS) Values: supplier, buyer isInformationOnly data.isInformationOnlyboolean
If true, invoice is for information only and no action required isERS data.isERSboolean
Evaluated Receipt Settlement invoice documentReference data.documentReferenceobject
Reference to previous invoice (for credit/debit memos or cancellations) invoiceId data.documentReference.invoiceIdstring
invoiceDate data.documentReference.invoiceDatestring
documentId data.documentReference.documentIdstring
payloadId data.documentReference.payloadIdstring
poReferences data.poReferencesarray
Purchase orders being invoiced. poNumber data.poReferences[].poNumberstring
poVersion data.poReferences[].poVersionstring
documentId data.poReferences[].documentIdstring
payloadId data.poReferences[].payloadIdstring
orderDate data.poReferences[].orderDatestring
asnReference data.asnReferenceobject
Shipment notice reference when invoicing against a dispatched shipment. shipmentId data.asnReference.shipmentIdstring
shipmentDate data.asnReference.shipmentDatestring
documentId data.asnReference.documentIdstring
payloadId data.asnReference.payloadIdstring
supplier data.supplierobject
Required Supplier or seller issuing the invoice. id data.supplier.idstring
Required name data.supplier.namestring
Required taxRegistrations data.supplier.taxRegistrationsarray
Australian tax registrations for the party type data.supplier.taxRegistrations[].typestring
Values: ABN value data.supplier.taxRegistrations[].valuestring
contact data.supplier.contactobject
name data.supplier.contact.namestring
phone data.supplier.contact.phonestring
email data.supplier.contact.emailstring
role data.supplier.contact.rolestring
address data.supplier.addressunknown
billTo data.billToobject
Required Buyer billing party. addressId data.billTo.addressIdstring
addressee data.billTo.addresseestring
Required street1 data.billTo.street1string
Required street2 data.billTo.street2string
city data.billTo.citystring
Required state data.billTo.statestring
Required postalCode data.billTo.postalCodestring
Required country data.billTo.countrystring
Required Values: AU soldTo data.soldTounknown
Sold-to party (may differ from bill-to) shipTo data.shipToobject
Standard address structure for DataShift canonical documents addressId data.shipTo.addressIdstring
addressee data.shipTo.addresseestring
Required street1 data.shipTo.street1string
Required street2 data.shipTo.street2string
city data.shipTo.citystring
Required state data.shipTo.statestring
Required postalCode data.shipTo.postalCodestring
Required country data.shipTo.countrystring
Required Values: AU remitTo data.remitToobject
Address where payment should be sent addressId data.remitTo.addressIdstring
addressee data.remitTo.addresseestring
street1 data.remitTo.street1string
street2 data.remitTo.street2string
city data.remitTo.citystring
state data.remitTo.statestring
postalCode data.remitTo.postalCodestring
country data.remitTo.countrystring
Values: AU bankDetails data.remitTo.bankDetailsobject
bankName data.remitTo.bankDetails.bankNamestring
accountName data.remitTo.bankDetails.accountNamestring
accountNumber data.remitTo.bankDetails.accountNumberstring
bsb data.remitTo.bankDetails.bsbstring
swift data.remitTo.bankDetails.swiftstring
iban data.remitTo.bankDetails.ibanstring
shipping data.shippingobject
Commercial freight charges and instructions for the invoice. amount data.shipping.amountnumber
currency data.shipping.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD carrier data.shipping.carrierstring
route data.shipping.routestring
shippingInstructions data.shipping.shippingInstructionsstring
buyerAcctNumber data.shipping.buyerAcctNumberstring
incoTerms data.shipping.incoTermsstring
Values: cfr, cif, cip, cpt, daf, dap (+9 more) shipmentDetails data.shipmentDetailsobject
Actual dispatch and tracking information for the invoiced goods carrier data.shipmentDetails.carrierstring
trackingNumber data.shipmentDetails.trackingNumberstring
shippingDate data.shipmentDetails.shippingDatestring
paymentTerms data.paymentTermsobject
Payment terms and conditions description data.paymentTerms.descriptionstring
Human-readable payment terms (e.g., 'Net 30', '2/10 Net 30') netDays data.paymentTerms.netDaysinteger
Number of days until payment is due discountTerms data.paymentTerms.discountTermsarray
Early payment discount tiers discountPercent data.paymentTerms.discountTerms[].discountPercentnumber
Discount percentage (e.g., 2 for 2%) discountDays data.paymentTerms.discountTerms[].discountDaysinteger
Days within which discount applies discountDueDate data.paymentTerms.discountTerms[].discountDueDatestring
Specific date by which discount applies contacts data.contactsarray
Contact information for various roles role data.contacts[].rolestring
Values: issuerOfInvoice, soldTo, billTo, remitTo, shipFrom, shipTo name data.contacts[].namestring
email data.contacts[].emailstring
phone data.contacts[].phonestring
comments data.commentsstring
Invoice-level comments or notes lineItems data.lineItemsarray
Required Invoice lines. DataShift manages uniqueLineKey correlation back to PO and ASN lines where needed. invoiceLineNumber data.lineItems[].invoiceLineNumberinteger
Supplier's line number for this invoice line. uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key from the original purchase order. poLineReference data.lineItems[].poLineReferenceinteger
Line number from the purchase order being invoiced. asnLineReference data.lineItems[].asnLineReferenceinteger
Line number from the ship notice supplierItemId data.lineItems[].supplierItemIdstring
Supplier's part/item number buyerItemId data.lineItems[].buyerItemIdstring
Buyer's part/item number description data.lineItems[].descriptionstring
Item description quantity data.lineItems[].quantitynumber
Quantity invoiced. unitOfMeasure data.lineItems[].unitOfMeasurestring
UN/ECE Recommendation 20 unit of measure codes for DataShift canonical documents Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].unitPricenumber
Unit price subtotal data.lineItems[].subtotalnumber
Line subtotal before tax and adjustments. taxAmount data.lineItems[].taxAmountnumber
Tax amount for this line taxRate data.lineItems[].taxRatenumber
Tax rate as percentage (e.g., 10 for 10%) discountAmount data.lineItems[].discountAmountnumber
Discount amount for this line shippingAmount data.lineItems[].shippingAmountnumber
Shipping charge for this line grossAmount data.lineItems[].grossAmountnumber
Subtotal + tax + shipping before discounts netAmount data.lineItems[].netAmountnumber
Gross amount minus discounts currency data.lineItems[].currencystring
ISO 4217 currency code for this line. Values: AUD manufacturerPartId data.lineItems[].manufacturerPartIdstring
Manufacturer's part number manufacturerName data.lineItems[].manufacturerNamestring
Manufacturer name countryOfOrigin data.lineItems[].countryOfOriginstring
Country where item was manufactured Values: AU serialNumbers data.lineItems[].serialNumbersarray
Serial numbers for serialized items batchId data.lineItems[].batchIdstring
Lot/batch ID classification data.lineItems[].classificationarray
Product classification codes domain data.lineItems[].classification[].domainstring
Classification scheme Values: UNSPSC, HS, commodity code data.lineItems[].classification[].codestring
comments data.lineItems[].commentsstring
Line-level comments invoiceSummary data.invoiceSummaryobject
Required Invoice totals, tax, discounts, and amount due. subtotal data.invoiceSummary.subtotalnumber
Required Sum of all line subtotals shippingAmount data.invoiceSummary.shippingAmountnumber
Total shipping charges specialHandlingAmount data.invoiceSummary.specialHandlingAmountnumber
Special handling charges taxAmount data.invoiceSummary.taxAmountnumber
Required Total tax amount taxBreakdown data.invoiceSummary.taxBreakdownarray
Tax breakdown by type/jurisdiction taxType data.invoiceSummary.taxBreakdown[].taxTypestring
Type of tax Values: GST, VAT, salesTax, excise, other taxRate data.invoiceSummary.taxBreakdown[].taxRatenumber
Tax rate as percentage taxableAmount data.invoiceSummary.taxBreakdown[].taxableAmountnumber
Amount subject to this tax taxAmount data.invoiceSummary.taxBreakdown[].taxAmountnumber
Calculated tax amount jurisdiction data.invoiceSummary.taxBreakdown[].jurisdictionstring
Tax jurisdiction (e.g., state, country) description data.invoiceSummary.taxBreakdown[].descriptionstring
discountAmount data.invoiceSummary.discountAmountnumber
Total discount amount grossAmount data.invoiceSummary.grossAmountnumber
Subtotal + tax + shipping + handling before discounts netAmount data.invoiceSummary.netAmountnumber
Gross amount minus discounts depositAmount data.invoiceSummary.depositAmountnumber
Prepayment/deposit already received dueAmount data.invoiceSummary.dueAmountnumber
Required Amount due (net - deposits) currency data.invoiceSummary.currencystring
Required ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD extrinsics data.extrinsicsobject
Partner-specific extension fields that are not part of the canonical core contract. 