Invoice

Invoice (810)

An Invoice is sent by a supplier to bill for goods or services that have been shipped.

Schema Overview Sample Downloads

Field	Type	Required	Description
invoiceDate	unknown	✓	Date the invoice was issued
invoiceNumber	string	✓	Unique invoice number assigned by the seller
purchaseOrderNumber	string	✓	Purchase order number being invoiced
purchaseOrderDate	unknown		Date the referenced purchase order was issued
releaseNumber	string		Release number for blanket or contract orders
invoiceType	string		Document polarity, independent of amount sign. invoice increases the amount owed; creditMemo reduces it. Values: `invoice` `creditMemo`
isConsolidated	boolean		Invoice consolidates multiple shipments or orders.
isDropShipment	boolean		Invoice is for a drop-shipment.
isFlsaCompliant	boolean		Indicates the invoice complies with the Fair Labor Standards Act (FLSA).
notesshow child fieldshide child fields	object		Notes and comments for the invoice
generalshow child fieldshide child fields	object		General notes or comments
description	string		Brief description or title of the note
text	array of string		Array of text lines for the note content
buyersCurrencyshow child fieldshide child fields	object		Currency used by the buyer
currencyCode	string	✓	ISO currency code (e.g., USD, EUR)
exchangeRate	string		Exchange rate for currency conversion
sellersCurrencyshow child fieldshide child fields	object		Currency used by the seller
currencyCode	string	✓	ISO currency code (e.g., USD, EUR)
exchangeRate	string		Exchange rate for currency conversion
referencesshow child fieldshide child fields	object		Reference numbers associated with the invoice
customerOrderNumbershow child fieldshide child fields	object		Customer-assigned order number
value	string		The reference identifier value
description	string		Additional description or context for the reference
divisionIdshow child fieldshide child fields	object		Business division identifier
value	string		The reference identifier value
description	string		Additional description or context for the reference
departmentNumbershow child fieldshide child fields	object		Department number within the organization
value	string		The reference identifier value
description	string		Additional description or context for the reference
vendorNumbershow child fieldshide child fields	object		Vendor or supplier identifier
value	string		The reference identifier value
description	string		Additional description or context for the reference
promotionNumbershow child fieldshide child fields	object		Promotional campaign or deal identifier
value	string		The reference identifier value
description	string		Additional description or context for the reference
thirdPartyReferenceNumbershow child fieldshide child fields	object		Reference number from a third-party system
value	string		The reference identifier value
description	string		Additional description or context for the reference
relatedInvoiceNumbershow child fieldshide child fields	object		Original invoice number being credited, used for credit invoices
value	string		The reference identifier value
description	string		Additional description or context for the reference
returnAuthorizationNumbershow child fieldshide child fields	object		Return merchandise authorization (RMA) number
value	string		The reference identifier value
description	string		Additional description or context for the reference
jobNumbershow child fieldshide child fields	object		Job or project number
value	string		The reference identifier value
description	string		Additional description or context for the reference
billOfLadingNumbershow child fieldshide child fields	object		Bill of lading number for the shipment
value	string		The reference identifier value
description	string		Additional description or context for the reference
proNumbershow child fieldshide child fields	object		Progressive or PRO number from the carrier
value	string		The reference identifier value
description	string		Additional description or context for the reference
trackingNumbershow child fieldshide child fields	object		Shipment tracking number
value	string		The reference identifier value
description	string		Additional description or context for the reference
shipmentIdshow child fieldshide child fields	object		Unique shipment identifier
value	string		The reference identifier value
description	string		Additional description or context for the reference
datesshow child fieldshide child fields	object		Important dates such as ship date and delivery date
shipDate	unknown		Date the goods were shipped
deliveryDate	unknown		Date the goods were delivered
partiesshow child fieldshide child fields	object		Parties involved in the invoice transaction. Includes contact information where available
buyershow child fieldshide child fields	object		Buying party who purchased the goods.
name	string		Party name or company name
additionalName1	string		Additional name line 1
additionalName2	string		Additional name line 2
identificationCode	string		Party identification code value
identificationCodeType	string		Type of identification code Values: `sendersId` `receiversId` `duns` `plantCode` `dunsPlus4` `drugEnforcementAdmin` `telephone` `federalReserveRouting` `standardAddressSAN` `healthIndustryHIN` `warehouse` `schoolId` `memberId` `stateLicenseId` `globalLocationId`
addressLine1	string		Street address line 1
addressLine2	string		Street address line 2
addressLine3	string		Street address line 3
addressLine4	string		Street address line 4
city	string		City name
stateOrProvinceCode	string		State or province code
postalCode	string		Postal or ZIP code
countryCode	string		Country code (ISO)
zoneType	string		Address zone type Values: `residential` `commercial`
contactsshow child fieldshide child fields	array		Contact persons for this party
type	string	✓	Type of contact. Default to 'primary' for party-level (N1_loop) PER segments and context-routed header-level PER segments — the parent party's role provides the context. Use other types only to distinguish multiple contacts within a single party (e.g. 'hazmat' for HM, 'shipping' for SD). Values: `primary` `customerRelations` `orderInquiry` `department` `shipping` `receiving` `hazmat`
name	string		Contact person name
phoneNumber	string		Contact phone number. Default source is the comm-number paired with a TE qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type (e.g. "Fax #", "Email"), follow the note and route accordingly.
faxNumber	string		Contact fax number. Default source is the comm-number paired with an FX qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on a comm-number element labels its value as fax even when the qualifier is TE/EM, follow the note and route the value here.
email	string		Contact email address. Default source is the comm-number paired with an EM qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type, follow the note and route accordingly.
shipToshow child fieldshide child fields	object		Ship-to location where goods were delivered
name	string		Party name or company name
additionalName1	string		Additional name line 1
additionalName2	string		Additional name line 2
identificationCode	string		Party identification code value
identificationCodeType	string		Type of identification code Values: `sendersId` `receiversId` `duns` `plantCode` `dunsPlus4` `drugEnforcementAdmin` `telephone` `federalReserveRouting` `standardAddressSAN` `healthIndustryHIN` `warehouse` `schoolId` `memberId` `stateLicenseId` `globalLocationId`
addressLine1	string		Street address line 1
addressLine2	string		Street address line 2
addressLine3	string		Street address line 3
addressLine4	string		Street address line 4
city	string		City name
stateOrProvinceCode	string		State or province code
postalCode	string		Postal or ZIP code
countryCode	string		Country code (ISO)
zoneType	string		Address zone type Values: `residential` `commercial`
contactsshow child fieldshide child fields	array		Contact persons for this party
type	string	✓	Type of contact. Default to 'primary' for party-level (N1_loop) PER segments and context-routed header-level PER segments — the parent party's role provides the context. Use other types only to distinguish multiple contacts within a single party (e.g. 'hazmat' for HM, 'shipping' for SD). Values: `primary` `customerRelations` `orderInquiry` `department` `shipping` `receiving` `hazmat`
name	string		Contact person name
phoneNumber	string		Contact phone number. Default source is the comm-number paired with a TE qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type (e.g. "Fax #", "Email"), follow the note and route accordingly.
faxNumber	string		Contact fax number. Default source is the comm-number paired with an FX qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on a comm-number element labels its value as fax even when the qualifier is TE/EM, follow the note and route the value here.
email	string		Contact email address. Default source is the comm-number paired with an EM qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type, follow the note and route accordingly.
billToshow child fieldshide child fields	object		Bill-to location for invoicing
name	string		Party name or company name
additionalName1	string		Additional name line 1
additionalName2	string		Additional name line 2
identificationCode	string		Party identification code value
identificationCodeType	string		Type of identification code Values: `sendersId` `receiversId` `duns` `plantCode` `dunsPlus4` `drugEnforcementAdmin` `telephone` `federalReserveRouting` `standardAddressSAN` `healthIndustryHIN` `warehouse` `schoolId` `memberId` `stateLicenseId` `globalLocationId`
addressLine1	string		Street address line 1
addressLine2	string		Street address line 2
addressLine3	string		Street address line 3
addressLine4	string		Street address line 4
city	string		City name
stateOrProvinceCode	string		State or province code
postalCode	string		Postal or ZIP code
countryCode	string		Country code (ISO)
zoneType	string		Address zone type Values: `residential` `commercial`
contactsshow child fieldshide child fields	array		Contact persons for this party
type	string	✓	Type of contact. Default to 'primary' for party-level (N1_loop) PER segments and context-routed header-level PER segments — the parent party's role provides the context. Use other types only to distinguish multiple contacts within a single party (e.g. 'hazmat' for HM, 'shipping' for SD). Values: `primary` `customerRelations` `orderInquiry` `department` `shipping` `receiving` `hazmat`
name	string		Contact person name
phoneNumber	string		Contact phone number. Default source is the comm-number paired with a TE qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type (e.g. "Fax #", "Email"), follow the note and route accordingly.
faxNumber	string		Contact fax number. Default source is the comm-number paired with an FX qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on a comm-number element labels its value as fax even when the qualifier is TE/EM, follow the note and route the value here.
email	string		Contact email address. Default source is the comm-number paired with an EM qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type, follow the note and route accordingly.
accountsReceivableshow child fieldshide child fields	object		Remit-to or payee party for payment.
name	string		Party name or company name
additionalName1	string		Additional name line 1
additionalName2	string		Additional name line 2
identificationCode	string		Party identification code value
identificationCodeType	string		Type of identification code Values: `sendersId` `receiversId` `duns` `plantCode` `dunsPlus4` `drugEnforcementAdmin` `telephone` `federalReserveRouting` `standardAddressSAN` `healthIndustryHIN` `warehouse` `schoolId` `memberId` `stateLicenseId` `globalLocationId`
addressLine1	string		Street address line 1
addressLine2	string		Street address line 2
addressLine3	string		Street address line 3
addressLine4	string		Street address line 4
city	string		City name
stateOrProvinceCode	string		State or province code
postalCode	string		Postal or ZIP code
countryCode	string		Country code (ISO)
zoneType	string		Address zone type Values: `residential` `commercial`
contactsshow child fieldshide child fields	array		Contact persons for this party
type	string	✓	Type of contact. Default to 'primary' for party-level (N1_loop) PER segments and context-routed header-level PER segments — the parent party's role provides the context. Use other types only to distinguish multiple contacts within a single party (e.g. 'hazmat' for HM, 'shipping' for SD). Values: `primary` `customerRelations` `orderInquiry` `department` `shipping` `receiving` `hazmat`
name	string		Contact person name
phoneNumber	string		Contact phone number. Default source is the comm-number paired with a TE qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type (e.g. "Fax #", "Email"), follow the note and route accordingly.
faxNumber	string		Contact fax number. Default source is the comm-number paired with an FX qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on a comm-number element labels its value as fax even when the qualifier is TE/EM, follow the note and route the value here.
email	string		Contact email address. Default source is the comm-number paired with an EM qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type, follow the note and route accordingly.
accountsPayableshow child fieldshide child fields	object		Payer party, used for credit invoices.
name	string		Party name or company name
additionalName1	string		Additional name line 1
additionalName2	string		Additional name line 2
identificationCode	string		Party identification code value
identificationCodeType	string		Type of identification code Values: `sendersId` `receiversId` `duns` `plantCode` `dunsPlus4` `drugEnforcementAdmin` `telephone` `federalReserveRouting` `standardAddressSAN` `healthIndustryHIN` `warehouse` `schoolId` `memberId` `stateLicenseId` `globalLocationId`
addressLine1	string		Street address line 1
addressLine2	string		Street address line 2
addressLine3	string		Street address line 3
addressLine4	string		Street address line 4
city	string		City name
stateOrProvinceCode	string		State or province code
postalCode	string		Postal or ZIP code
countryCode	string		Country code (ISO)
zoneType	string		Address zone type Values: `residential` `commercial`
contactsshow child fieldshide child fields	array		Contact persons for this party
type	string	✓	Type of contact. Default to 'primary' for party-level (N1_loop) PER segments and context-routed header-level PER segments — the parent party's role provides the context. Use other types only to distinguish multiple contacts within a single party (e.g. 'hazmat' for HM, 'shipping' for SD). Values: `primary` `customerRelations` `orderInquiry` `department` `shipping` `receiving` `hazmat`
name	string		Contact person name
phoneNumber	string		Contact phone number. Default source is the comm-number paired with a TE qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type (e.g. "Fax #", "Email"), follow the note and route accordingly.
faxNumber	string		Contact fax number. Default source is the comm-number paired with an FX qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on a comm-number element labels its value as fax even when the qualifier is TE/EM, follow the note and route the value here.
email	string		Contact email address. Default source is the comm-number paired with an EM qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type, follow the note and route accordingly.
termsOfSaleshow child fieldshide child fields	object		Payment terms and conditions
type	string		Type of payment terms Values: `basic` `basicDiscountOffered` `discountNotApplicable` `endOfMonth` `endOfMonth10` `extended` `instant` `fixedDate` `proximo` `mutuallyDefined`
basisDate	string		Date basis for calculating payment terms Values: `invoiceDate` `receiptOfGoods` `deliveryDate` `shipDate` `mutuallyDefined` `gageApprovalDate` `specifiedDate` `acceptanceDate` `invoiceTransmissionDate` `effectiveDate`
discountPercent	string		Discount percentage if paid early
discountDaysDue	integer		Number of days to qualify for discount
discountDueDate	unknown		Date by which payment must be made for discount
dayOfMonth	integer		Day of month for payment
netDaysDue	integer		Number of days until payment is due
netDueDate	unknown		Date when payment is due
discountAmount	string		Fixed discount amount
description	string		Description of payment terms
paymentMethodType	string		Method of payment Values: `check` `letterOfCredit` `wireTransfer` `corporateTradePayment` `specialAccount` `directPayOthers`
carrierDetailsshow child fieldshide child fields	object		Carrier and shipping details for the invoice
quantityAndWeightshow child fieldshide child fields	array		Quantity and weight details for the shipment
packageForm	string		Form of packaging Values: `bag` `carton` `case` `coil` `pallet`
packageMaterial	string		Material of packaging Values: `aluminum` `corrugated` `plastic` `plasticVacuumed` `standard` `steel` `wood`
weightUOM	string		Unit of measure for weight Values: `pound` `kilogram`
grossWeight	string		Gross weight including packaging
netWeight	string		Net weight of contents only
volume	string		Total volume of the shipment
volumeUOM	string		Unit of measure for volume Values: `cubicFeet` `cubicInches` `cubicMeter` `cubicYard` `gallon` `liter`
dimensionUOM	string		Unit of measure for length Values: `foot` `meter`
length	string		Total linear length of coils in the shipment
basebox	string		Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
ladingQuantity	string		Unit count based on the package form (e.g., number of cartons or pallets)
routingshow child fieldshide child fields	array		Carrier routing and transportation details
sequenceType	string		Sequence in the routing chain Values: `origin` `1stAfterOrigin` `4thAfterOrigin` `haulage`
standardCarrierAlphaCode	string		SCAC code identifying the carrier
customCarrierCode	string		Custom carrier identifier
transportationMethod	string		Method of transportation. EDIFACT: prefer C001.8179 (transportMeansDescriptionCode) — its means/vessel-level codes match this enum directly. Fall back to C220.8067 (transportModeNameCode) ONLY when 8179 is absent; 8067 carries broad-mode codes only (1=Maritime, 2=Rail, 3=Road, 4=Air, 5=Mail, 6=Multimodal, 7=Fixed installation, 8=Inland water) which map loosely: 1→ocean, 2→rail, 3→supplierTruck, 4→air. Granular enum values (airExpress, oceanContainerized, trailer, etc.) cannot be recovered from 8067 — emit a SCHEMA GAP if neither path carries the partner value. Values: `air` `airExpress` `airFreightForward` `backhaul` `bestWay` `commonCarrier` `consolidation` `customerPickup` `expeditedTruck` `lessThanTrailerLoad` `mail` `ocean` `oceanContainerized` `parcelPost` `privateCarrier` `rail` `shipperAgent` `supplierTruck` `trailer` `mutuallyDefined`
locationType	string		Type of routing location Values: `inStore` `receiversLocation` `allPoints` `portOfArrival` `portOfEmbarkation` `origin` `mutuallyDefined`
location	string		Routing location identifier or name
description	string		Description of routing details
serviceLevel	string		Service level for shipping Values: `deliveryConfirmation` `doorService` `economy` `eveningService` `expedited` `firstClass` `ground` `groundHundredWeight` `international` `metro` `morning` `nextDayAir` `nextDayHundredWeight` `nextDayEvening` `nextDayMorning1030` `nextDayMorning930` `nextDaySaturday` `overnight` `poBoxZipCode` `priorityMail` `priorityMailInsured` `proofOfDelivery` `sameDay` `saturdayService` `secondDay` `secondDayHundredWeight` `secondDayAir` `secondDaySaturday` `standard` `standardGround` `threeDay`
orderStatus	string		Order shipping status Values: `shipCompleteOnDate` `complete` `partialShipment` `shipPartialBackorderToShipOnDate` `partialShipOnDate` `shipped` `backordered` `mutuallyDefined` `availableScheduledToShip` `availableNoShipSchedule` `multiPickup` `availableToShipUnBilledQuantity` `stopOff`
transitDirectionType	string		Direction of transit Values: `buyerToSeller` `sellerToBuyer` `subcontractorToSeller` `sellerToDropShipLocation` `sellToForwarder` `sellerToSubcontractor` `mutuallyDefined`
transitTimeType	string		Unit for transit time Values: `calendarDays` `hours` `workingDays`
transitTime	string		Expected transit time value
equipmentshow child fieldshide child fields	object		Equipment details such as trailer information
equipmentType	string		Type of transportation equipment Values: `container` `reefer` `trailer` `oceanVessel`
equipmentId	string		Equipment identifier (e.g., trailer number)
sealNumber	string		Seal number for security verification
freeOnBoardshow child fieldshide child fields	array		FOB (Free on Board) terms and conditions
methodOfPayment	string		Freight payment method Values: `airCollect` `airPrepaid` `paidByBuyer` `collect` `mutuallyAgreed` `portOfCall` `halfPrepaid` `mixed` `serviceFreightNoCharge` `advancePrepaid` `customerPickupBackhaul` `prepaidChargeCustomer` `prepaidBySeller` `paidBySeller` `pickup` `thirdPartyPay`
locationType	string		Type of FOB location Values: `cityAndState` `country` `destination` `origin` `stateProvince` `warehouse`
locationDescription	string		Description of FOB location
titlePassageType	string		Type of title passage location Values: `cityAndState` `country` `destination` `origin` `stateProvince` `warehouse`
titlePassageDescription	string		Description of title passage location
transportationTermsSource	string		Source of transportation terms Values: `incoTerms` `tradeTerms` `mutuallyDefined`
transportationTerms	string		Incoterms or trade terms code Values: `costAndFreight` `costInsuranceAndFreight` `carriageAndInsurancePaidTo` `carriagePaidTo` `deliveredAtFrontier` `deliverDutyPaid` `deliverDutyUnpaid` `deliveredDutyUnpaid` `deliveredExQuay` `deliveredExShip` `domesticallySupplied` `exQuay` `exShip` `exWorks` `freeAlongsideShip` `freeCarrier` `freightCarriageInsurancePaidTo` `freightCarriagePaidTo` `freeOnBoard` `freeOnRail` `freeOnTruck` `nonPrivilegedForeign` `privilegedForeign` `mutuallyDefined`
riskOfLoss	string		Risk of loss transfer point Values: `toDestinationBuyer` `toFreightEqPointSeller` `toPoolPointSeller` `toDestinationSeller` `mutuallyDefined`
description	string		Additional FOB description
lineItemsshow child fieldshide child fields	array	✓	Line items included in the invoice
purchaseOrderLineId	string		Line item identifier from the original purchase order
quantityInvoicedshow child fieldshide child fields	object	✓	Quantity being invoiced for this line item
value	string	✓	Numeric quantity value
unitOfMeasure	string		Unit of measure for the quantity Values: `assembly` `assortment` `bag` `bale` `ball` `bar` `barrel` `belt` `bin` `block` `boardFeet` `bolt` `book` `bottle` `box` `bulk` `bundle` `bushel` `cake` `can` `card` `carton` `cartridge` `case` `cassette` `celsius` `cell` `centigram` `centiliter` `centimeter` `coil` `combo` `cone` `container` `count` `cover` `display` `dozen` `drum` `each` `flakeTon` `foot` `gallon` `gram` `gramsPerLiter` `inch` `kilogram` `kit` `knots` `linearFoot` `liter` `meter` `milliliter` `monetaryValue` `ocularInsertSystem` `order` `ounce` `packPAK` `package` `pad` `pail` `pair` `pairInches` `palletLift` `palletUnitLoad` `person` `piece` `pint` `pound` `poundEquivalent` `poundGross` `quart` `reel` `roll` `section` `set` `sheet` `sixPack` `squareFoot` `syringe` `thousand` `threePack` `tote` `tube` `unit` `vial`
unitPrice	string	✓	Unit price for the item
unitPriceBasis	string		Basis on which the unit price is calculated Values: `advise` `beforeDiscount` `discount` `net` `noCharge` `perHundred` `perThousand` `perDozen` `perEach` `perFoot` `perGram` `perKilogram` `perTen` `perOunce` `perPound` `perTenThousand` `perUOM` `promotion` `standard` `suggestedRetail` `wholesale` `wholesalePerEach`
productIdsshow child fieldshide child fields	object	✓	Product identification codes such as UPC, SKU, or vendor item number
buyerItemNumber	string		Buyer-assigned item number
vendorItemNumber	string		Vendor-assigned item number (EDIFACT LIN/PIA supplier's item number)
gtin12	string		GTIN-12 (UPC-A) barcode
gtin13	string		GTIN-13 (EAN) barcode
gtin14	string		GTIN-14 (ITF-14) case code barcode
caseCode	string		Case code identifier
drugCode	string		National Drug Code (NDC)
standardBookNumber	string		ISBN or standard book number
buyerItemIdsshow child fieldshide child fields	array		Additional buyer product identifiers
type	string	✓	Type of product identifier Values: `catalog` `manufacturerPart` `sku` `style`
value	string	✓	Product identifier value
vendorItemIdsshow child fieldshide child fields	array		Additional vendor product identifiers
type	string	✓	Type of product identifier Values: `catalog` `manufacturerPart` `sku` `style`
value	string	✓	Product identifier value
productAttributesshow child fieldshide child fields	object		Product attributes such as color, size, and description
description	string		General product description. Sourced from X12 PID05 when PID02="08" (Product Description, general) or when PID02 is absent. In EDIFACT, sourced from EVERY IMD composite for this line item where itemDescriptionCode="SP" (Product) — there may be MULTIPLE matching IMD repetitions per line item, and ALL of them must be included. Within each matching IMD, concatenate itemDescription + itemDescription_1 (the continuation field) with a single space; then $join those per-IMD strings across ALL matching IMDs with a single space separator. Do NOT pick only the first matching IMD — partners commonly split a long description across multiple IMD segments because each itemDescription element is capped at 35 characters. The qualifier code "SP" (or X12 "08") is positional — it identifies which IMDs carry the product description, and must NOT be reported as a schema gap.
shortDescription	string		{"description":"Short product description"}
brand	string		Brand or label name for the product
colorCode	string		Color code identifier
colorDescription	string		Color description text
sizeCode	string		Size code identifier
sizeDescription	string		Size description text
materialCode	string		Material code identifier
materialDescription	string		Material description text
materialAttributesshow child fieldshide child fields	object
type	string		Material type or classification
grade	string		Material grade or quality tier (e.g., prime, excessPrime, waste)
annealMethod	string		Annealing method applied to the material
temper	string		Heat treatment or mechanical processing state of the material
finish	string		Surface finish or texture applied to the material
outerCoating	string		Outer surface coating or plating
innerCoating	string		Inner surface coating or plating
surfaceProtection	string		Surface protection method or specification
treatment	string		Chemical or mechanical treatment applied to the material
weld	string		Welding specification or classification for the material
processCode	string		Process code identifier
processDescription	string		Process description text
height	string		Product height dimension
length	string		Product length dimension
width	string		Product width dimension
dimensionUOM	string		Unit of measure for product dimensions Values: `standardCubicFoot` `boardFeet` `hundredBoardFeet` `cubicDecimeter` `cubicCentimeter` `cubicFeet` `cubicInches` `centimeter` `cubicMeter` `cubicYard` `decimeter` `foot` `hundredFeet` `hundredFeetLinear` `hundredSquareFeet` `hundredYards` `inch` `linearFoot` `linearMeter` `linearYard` `millimeter` `meter` `squareFoot` `squareInches` `squareMeter` `squareYard` `thousandSquareInches` `thousandFeetLinear` `thousandFeetBoard` `tenSquareFeet` `thousandSquareFeet` `yard`
countryOfOrigin	string		Country where the product was manufactured
lotNumber	string		Lot or batch number for the product
datesshow child fieldshide child fields	object		Date references for this line item
lotExpirationDate	unknown		Expiration date of the lot or batch for this line item
outerPackshow child fieldshide child fields	object		Physical details for the outer packaging (case/carton level). When the guideline permits only one PO4 segment per line item and `innerPack` is also provided, the writer combines both into a single PO4 with outer dimensions taking precedence (PO401–PO406) and inner-only fields filling later positions (PO407+).
numberOfUnits	string		Number of units in the package
size	string		Size value of the package
sizeUOM	string		Unit of measure for size Values: `bag` `box` `carton` `case` `cassette` `each` `fluidOunce` `gram` `kilogram` `liter` `milliliter` `ounce` `packPAK` `package` `pair` `pound` `roll` `tote` `unit`
packageForm	string		Form of the package Values: `bag` `bottle` `box` `can` `carton` `coil` `container` `pallet` `shrinkWrap` `unit`
packageMaterial	string		Material of the package Values: `corrugated` `plastic` `plasticVacuumed` `standard` `wood`
weightUOM	string		Unit of measure for weight Values: `pound` `kilogram`
grossWeight	string		Gross weight including packaging
netWeight	string		Net weight of contents only
volumeUOM	string		Unit of measure for volume Values: `standardCubicFoot` `centiliter` `cubicDecimeter` `cubicCentimeter` `cubicFeet` `cubicInches` `cubicMeter` `cubicYard` `deciliter` `fluidOunce` `gallon` `halfGallon` `kiloliter` `kilogramsPerCubicMeter` `liter` `milliliter` `netGallons` `pint` `halfPint` `quart`
volume	string		Volume value
length	string		Length dimension
width	string		Width dimension
height	string		Height dimension
dimensionUOM	string		Unit of measure for dimensions Values: `standardCubicFoot` `boardFeet` `hundredBoardFeet` `cubicDecimeter` `cubicCentimeter` `cubicFeet` `cubicInches` `centimeter` `cubicMeter` `cubicYard` `decimeter` `foot` `hundredFeet` `hundredFeetLinear` `hundredSquareFeet` `hundredYards` `inch` `linearFoot` `linearMeter` `linearYard` `millimeter` `meter` `squareFoot` `squareInches` `squareMeter` `squareYard` `thousandSquareInches` `thousandFeetLinear` `thousandFeetBoard` `tenSquareFeet` `thousandSquareFeet` `yard`
packageId	string		Package identifier
basebox	string		Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
baseboxBasisWeight	string		Basis weight in pounds per base box — the standard steel mill weight specification unit
innerPackshow child fieldshide child fields	object		Physical details for the inner packaging
numberOfUnits	string		Number of units in the package
size	string		Size value of the package
sizeUOM	string		Unit of measure for size Values: `bag` `box` `carton` `case` `cassette` `each` `fluidOunce` `gram` `kilogram` `liter` `milliliter` `ounce` `packPAK` `package` `pair` `pound` `roll` `tote` `unit`
packageForm	string		Form of the package Values: `bag` `bottle` `box` `can` `carton` `coil` `container` `pallet` `shrinkWrap` `unit`
packageMaterial	string		Material of the package Values: `corrugated` `plastic` `plasticVacuumed` `standard` `wood`
weightUOM	string		Unit of measure for weight Values: `pound` `kilogram`
grossWeight	string		Gross weight including packaging
netWeight	string		Net weight of contents only
volumeUOM	string		Unit of measure for volume Values: `standardCubicFoot` `centiliter` `cubicDecimeter` `cubicCentimeter` `cubicFeet` `cubicInches` `cubicMeter` `cubicYard` `deciliter` `fluidOunce` `gallon` `halfGallon` `kiloliter` `kilogramsPerCubicMeter` `liter` `milliliter` `netGallons` `pint` `halfPint` `quart`
volume	string		Volume value
length	string		Length dimension
width	string		Width dimension
height	string		Height dimension
dimensionUOM	string		Unit of measure for dimensions Values: `standardCubicFoot` `boardFeet` `hundredBoardFeet` `cubicDecimeter` `cubicCentimeter` `cubicFeet` `cubicInches` `centimeter` `cubicMeter` `cubicYard` `decimeter` `foot` `hundredFeet` `hundredFeetLinear` `hundredSquareFeet` `hundredYards` `inch` `linearFoot` `linearMeter` `linearYard` `millimeter` `meter` `squareFoot` `squareInches` `squareMeter` `squareYard` `thousandSquareInches` `thousandFeetLinear` `thousandFeetBoard` `tenSquareFeet` `thousandSquareFeet` `yard`
packageId	string		Package identifier
basebox	string		Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
baseboxBasisWeight	string		Basis weight in pounds per base box — the standard steel mill weight specification unit
referencesshow child fieldshide child fields	object		Reference numbers for this line item
relatedInvoiceNumbershow child fieldshide child fields	object		Related invoice number for this line item
value	string		The reference identifier value
description	string		Additional description or context for the reference
returnAuthorizationNumbershow child fieldshide child fields	object		Return merchandise authorization number
value	string		The reference identifier value
description	string		Additional description or context for the reference
billOfLadingNumbershow child fieldshide child fields	object		Bill of lading number for this line item
value	string		The reference identifier value
description	string		Additional description or context for the reference
proNumbershow child fieldshide child fields	object		PRO number from the carrier
value	string		The reference identifier value
description	string		Additional description or context for the reference
trackingNumbershow child fieldshide child fields	object		Tracking number for this line item
value	string		The reference identifier value
description	string		Additional description or context for the reference
shipmentIdshow child fieldshide child fields	object		Shipment identifier for this line item
value	string		The reference identifier value
description	string		Additional description or context for the reference
allowancesshow child fieldshide child fields	array		Allowances or discounts for this line item
type	string	✓	Type of allowance or charge Values: `advertising` `defectiveAllowance` `discount` `freight` `handling` `newStore` `other` `promotionalAllowance` `quantityDiscount` `rebate` `restocking` `serviceAtPickupOrDelivery` `shipping` `shippingAndHandling` `swell` `unsaleableMerchandiseAllowance` `volume` `warehouse`
amount	string		Fixed amount of allowance or charge
percent	string		Percentage of allowance or charge
percentBasis	string		Basis for calculating percentage Values: `basePrice`
methodOfHandling	string		How the charge is handled Values: `collect` `paidByVendor` `paidByCustomer` `prepaid`
description	string		Description of the allowance or charge
chargesshow child fieldshide child fields	array		Additional charges for this line item
type	string	✓	Type of allowance or charge Values: `advertising` `defectiveAllowance` `discount` `freight` `handling` `newStore` `other` `promotionalAllowance` `quantityDiscount` `rebate` `restocking` `serviceAtPickupOrDelivery` `shipping` `shippingAndHandling` `swell` `unsaleableMerchandiseAllowance` `volume` `warehouse`
amount	string		Fixed amount of allowance or charge
percent	string		Percentage of allowance or charge
percentBasis	string		Basis for calculating percentage Values: `basePrice`
methodOfHandling	string		How the charge is handled Values: `collect` `paidByVendor` `paidByCustomer` `prepaid`
description	string		Description of the allowance or charge
carrierDetailsshow child fieldshide child fields	object		Carrier and shipping details for this line item
routingshow child fieldshide child fields	array		Carrier routing information
sequenceType	string		Sequence in the routing chain Values: `origin` `1stAfterOrigin` `4thAfterOrigin` `haulage`
standardCarrierAlphaCode	string		SCAC code identifying the carrier
customCarrierCode	string		Custom carrier identifier
transportationMethod	string		Method of transportation. EDIFACT: prefer C001.8179 (transportMeansDescriptionCode) — its means/vessel-level codes match this enum directly. Fall back to C220.8067 (transportModeNameCode) ONLY when 8179 is absent; 8067 carries broad-mode codes only (1=Maritime, 2=Rail, 3=Road, 4=Air, 5=Mail, 6=Multimodal, 7=Fixed installation, 8=Inland water) which map loosely: 1→ocean, 2→rail, 3→supplierTruck, 4→air. Granular enum values (airExpress, oceanContainerized, trailer, etc.) cannot be recovered from 8067 — emit a SCHEMA GAP if neither path carries the partner value. Values: `air` `airExpress` `airFreightForward` `backhaul` `bestWay` `commonCarrier` `consolidation` `customerPickup` `expeditedTruck` `lessThanTrailerLoad` `mail` `ocean` `oceanContainerized` `parcelPost` `privateCarrier` `rail` `shipperAgent` `supplierTruck` `trailer` `mutuallyDefined`
locationType	string		Type of routing location Values: `inStore` `receiversLocation` `allPoints` `portOfArrival` `portOfEmbarkation` `origin` `mutuallyDefined`
location	string		Routing location identifier or name
description	string		Description of routing details
serviceLevel	string		Service level for shipping Values: `deliveryConfirmation` `doorService` `economy` `eveningService` `expedited` `firstClass` `ground` `groundHundredWeight` `international` `metro` `morning` `nextDayAir` `nextDayHundredWeight` `nextDayEvening` `nextDayMorning1030` `nextDayMorning930` `nextDaySaturday` `overnight` `poBoxZipCode` `priorityMail` `priorityMailInsured` `proofOfDelivery` `sameDay` `saturdayService` `secondDay` `secondDayHundredWeight` `secondDayAir` `secondDaySaturday` `standard` `standardGround` `threeDay`
orderStatus	string		Order shipping status Values: `shipCompleteOnDate` `complete` `partialShipment` `shipPartialBackorderToShipOnDate` `partialShipOnDate` `shipped` `backordered` `mutuallyDefined` `availableScheduledToShip` `availableNoShipSchedule` `multiPickup` `availableToShipUnBilledQuantity` `stopOff`
transitDirectionType	string		Direction of transit Values: `buyerToSeller` `sellerToBuyer` `subcontractorToSeller` `sellerToDropShipLocation` `sellToForwarder` `sellerToSubcontractor` `mutuallyDefined`
transitTimeType	string		Unit for transit time Values: `calendarDays` `hours` `workingDays`
transitTime	string		Expected transit time value
sublineItemsshow child fieldshide child fields	array		Subline items for component or kit details
sublineId	string		Subline item identifier
quantityshow child fieldshide child fields	object		Quantity for the subline item
value	string	✓	Numeric quantity value
unitOfMeasure	string		Unit of measure for the quantity Values: `assembly` `assortment` `bag` `bale` `ball` `bar` `barrel` `belt` `bin` `block` `boardFeet` `bolt` `book` `bottle` `box` `bulk` `bundle` `bushel` `cake` `can` `card` `carton` `cartridge` `case` `cassette` `celsius` `cell` `centigram` `centiliter` `centimeter` `coil` `combo` `cone` `container` `count` `cover` `display` `dozen` `drum` `each` `flakeTon` `foot` `gallon` `gram` `gramsPerLiter` `inch` `kilogram` `kit` `knots` `linearFoot` `liter` `meter` `milliliter` `monetaryValue` `ocularInsertSystem` `order` `ounce` `packPAK` `package` `pad` `pail` `pair` `pairInches` `palletLift` `palletUnitLoad` `person` `piece` `pint` `pound` `poundEquivalent` `poundGross` `quart` `reel` `roll` `section` `set` `sheet` `sixPack` `squareFoot` `syringe` `thousand` `threePack` `tote` `tube` `unit` `vial`
unitCostPrice	string		Unit cost price for the subline item
unitPriceBasis	string		Basis for the unit price Values: `advise` `beforeDiscount` `discount` `net` `noCharge` `perHundred` `perThousand` `perDozen` `perEach` `perFoot` `perGram` `perKilogram` `perTen` `perOunce` `perPound` `perTenThousand` `perUOM` `promotion` `standard` `suggestedRetail` `wholesale` `wholesalePerEach`
productIdsshow child fieldshide child fields	object	✓	Product identifiers for the subline item
buyerItemNumber	string		Buyer-assigned item number
vendorItemNumber	string		Vendor-assigned item number (EDIFACT LIN/PIA supplier's item number)
gtin12	string		GTIN-12 (UPC-A) barcode
gtin13	string		GTIN-13 (EAN) barcode
gtin14	string		GTIN-14 (ITF-14) case code barcode
caseCode	string		Case code identifier
drugCode	string		National Drug Code (NDC)
standardBookNumber	string		ISBN or standard book number
buyerItemIdsshow child fieldshide child fields	array		Additional buyer product identifiers
type	string	✓	Type of product identifier Values: `catalog` `manufacturerPart` `sku` `style`
value	string	✓	Product identifier value
vendorItemIdsshow child fieldshide child fields	array		Additional vendor product identifiers
type	string	✓	Type of product identifier Values: `catalog` `manufacturerPart` `sku` `style`
value	string	✓	Product identifier value
productAttributesshow child fieldshide child fields	object		Product attributes for the subline item
description	string		General product description. Sourced from X12 PID05 when PID02="08" (Product Description, general) or when PID02 is absent. In EDIFACT, sourced from EVERY IMD composite for this line item where itemDescriptionCode="SP" (Product) — there may be MULTIPLE matching IMD repetitions per line item, and ALL of them must be included. Within each matching IMD, concatenate itemDescription + itemDescription_1 (the continuation field) with a single space; then $join those per-IMD strings across ALL matching IMDs with a single space separator. Do NOT pick only the first matching IMD — partners commonly split a long description across multiple IMD segments because each itemDescription element is capped at 35 characters. The qualifier code "SP" (or X12 "08") is positional — it identifies which IMDs carry the product description, and must NOT be reported as a schema gap.
shortDescription	string		{"description":"Short product description"}
brand	string		Brand or label name for the product
colorCode	string		Color code identifier
colorDescription	string		Color description text
sizeCode	string		Size code identifier
sizeDescription	string		Size description text
materialCode	string		Material code identifier
materialDescription	string		Material description text
materialAttributesshow child fieldshide child fields	object
type	string		Material type or classification
grade	string		Material grade or quality tier (e.g., prime, excessPrime, waste)
annealMethod	string		Annealing method applied to the material
temper	string		Heat treatment or mechanical processing state of the material
finish	string		Surface finish or texture applied to the material
outerCoating	string		Outer surface coating or plating
innerCoating	string		Inner surface coating or plating
surfaceProtection	string		Surface protection method or specification
treatment	string		Chemical or mechanical treatment applied to the material
weld	string		Welding specification or classification for the material
processCode	string		Process code identifier
processDescription	string		Process description text
height	string		Product height dimension
length	string		Product length dimension
width	string		Product width dimension
dimensionUOM	string		Unit of measure for product dimensions Values: `standardCubicFoot` `boardFeet` `hundredBoardFeet` `cubicDecimeter` `cubicCentimeter` `cubicFeet` `cubicInches` `centimeter` `cubicMeter` `cubicYard` `decimeter` `foot` `hundredFeet` `hundredFeetLinear` `hundredSquareFeet` `hundredYards` `inch` `linearFoot` `linearMeter` `linearYard` `millimeter` `meter` `squareFoot` `squareInches` `squareMeter` `squareYard` `thousandSquareInches` `thousandFeetLinear` `thousandFeetBoard` `tenSquareFeet` `thousandSquareFeet` `yard`
lotNumber	string		Lot or batch number for the subline item
additionalQuantitiesshow child fieldshide child fields	object		Additional quantity details beyond the invoiced quantity, such as shipped, backordered, canceled, or substituted quantities
shippedshow child fieldshide child fields	object		Quantity shipped for this line item
value	string	✓	Numeric quantity value
unitOfMeasure	string		Unit of measure for the quantity Values: `assembly` `assortment` `bag` `bale` `ball` `bar` `barrel` `belt` `bin` `block` `boardFeet` `bolt` `book` `bottle` `box` `bulk` `bundle` `bushel` `cake` `can` `card` `carton` `cartridge` `case` `cassette` `celsius` `cell` `centigram` `centiliter` `centimeter` `coil` `combo` `cone` `container` `count` `cover` `display` `dozen` `drum` `each` `flakeTon` `foot` `gallon` `gram` `gramsPerLiter` `inch` `kilogram` `kit` `knots` `linearFoot` `liter` `meter` `milliliter` `monetaryValue` `ocularInsertSystem` `order` `ounce` `packPAK` `package` `pad` `pail` `pair` `pairInches` `palletLift` `palletUnitLoad` `person` `piece` `pint` `pound` `poundEquivalent` `poundGross` `quart` `reel` `roll` `section` `set` `sheet` `sixPack` `squareFoot` `syringe` `thousand` `threePack` `tote` `tube` `unit` `vial`
partialShipmentshow child fieldshide child fields	object		Quantity partially shipped, including prior shipments, split shipments, or scheduled shipments
value	string	✓	Numeric quantity value
unitOfMeasure	string		Unit of measure for the quantity Values: `assembly` `assortment` `bag` `bale` `ball` `bar` `barrel` `belt` `bin` `block` `boardFeet` `bolt` `book` `bottle` `box` `bulk` `bundle` `bushel` `cake` `can` `card` `carton` `cartridge` `case` `cassette` `celsius` `cell` `centigram` `centiliter` `centimeter` `coil` `combo` `cone` `container` `count` `cover` `display` `dozen` `drum` `each` `flakeTon` `foot` `gallon` `gram` `gramsPerLiter` `inch` `kilogram` `kit` `knots` `linearFoot` `liter` `meter` `milliliter` `monetaryValue` `ocularInsertSystem` `order` `ounce` `packPAK` `package` `pad` `pail` `pair` `pairInches` `palletLift` `palletUnitLoad` `person` `piece` `pint` `pound` `poundEquivalent` `poundGross` `quart` `reel` `roll` `section` `set` `sheet` `sixPack` `squareFoot` `syringe` `thousand` `threePack` `tote` `tube` `unit` `vial`
backOrderedshow child fieldshide child fields	object		Quantity on backorder that will be fulfilled in a future shipment
value	string	✓	Numeric quantity value
unitOfMeasure	string		Unit of measure for the quantity Values: `assembly` `assortment` `bag` `bale` `ball` `bar` `barrel` `belt` `bin` `block` `boardFeet` `bolt` `book` `bottle` `box` `bulk` `bundle` `bushel` `cake` `can` `card` `carton` `cartridge` `case` `cassette` `celsius` `cell` `centigram` `centiliter` `centimeter` `coil` `combo` `cone` `container` `count` `cover` `display` `dozen` `drum` `each` `flakeTon` `foot` `gallon` `gram` `gramsPerLiter` `inch` `kilogram` `kit` `knots` `linearFoot` `liter` `meter` `milliliter` `monetaryValue` `ocularInsertSystem` `order` `ounce` `packPAK` `package` `pad` `pail` `pair` `pairInches` `palletLift` `palletUnitLoad` `person` `piece` `pint` `pound` `poundEquivalent` `poundGross` `quart` `reel` `roll` `section` `set` `sheet` `sixPack` `squareFoot` `syringe` `thousand` `threePack` `tote` `tube` `unit` `vial`
unavailableshow child fieldshide child fields	object		Quantity unavailable due to being out of stock, discontinued, or otherwise not available
value	string	✓	Numeric quantity value
unitOfMeasure	string		Unit of measure for the quantity Values: `assembly` `assortment` `bag` `bale` `ball` `bar` `barrel` `belt` `bin` `block` `boardFeet` `bolt` `book` `bottle` `box` `bulk` `bundle` `bushel` `cake` `can` `card` `carton` `cartridge` `case` `cassette` `celsius` `cell` `centigram` `centiliter` `centimeter` `coil` `combo` `cone` `container` `count` `cover` `display` `dozen` `drum` `each` `flakeTon` `foot` `gallon` `gram` `gramsPerLiter` `inch` `kilogram` `kit` `knots` `linearFoot` `liter` `meter` `milliliter` `monetaryValue` `ocularInsertSystem` `order` `ounce` `packPAK` `package` `pad` `pail` `pair` `pairInches` `palletLift` `palletUnitLoad` `person` `piece` `pint` `pound` `poundEquivalent` `poundGross` `quart` `reel` `roll` `section` `set` `sheet` `sixPack` `squareFoot` `syringe` `thousand` `threePack` `tote` `tube` `unit` `vial`
canceledshow child fieldshide child fields	object		Quantity canceled by the buyer or seller, including items deleted or discontinued from the order
value	string	✓	Numeric quantity value
unitOfMeasure	string		Unit of measure for the quantity Values: `assembly` `assortment` `bag` `bale` `ball` `bar` `barrel` `belt` `bin` `block` `boardFeet` `bolt` `book` `bottle` `box` `bulk` `bundle` `bushel` `cake` `can` `card` `carton` `cartridge` `case` `cassette` `celsius` `cell` `centigram` `centiliter` `centimeter` `coil` `combo` `cone` `container` `count` `cover` `display` `dozen` `drum` `each` `flakeTon` `foot` `gallon` `gram` `gramsPerLiter` `inch` `kilogram` `kit` `knots` `linearFoot` `liter` `meter` `milliliter` `monetaryValue` `ocularInsertSystem` `order` `ounce` `packPAK` `package` `pad` `pail` `pair` `pairInches` `palletLift` `palletUnitLoad` `person` `piece` `pint` `pound` `poundEquivalent` `poundGross` `quart` `reel` `roll` `section` `set` `sheet` `sixPack` `squareFoot` `syringe` `thousand` `threePack` `tote` `tube` `unit` `vial`
substitutionshow child fieldshide child fields	object		Quantity substituted with an alternate product
value	string	✓	Numeric quantity value
unitOfMeasure	string		Unit of measure for the quantity Values: `assembly` `assortment` `bag` `bale` `ball` `bar` `barrel` `belt` `bin` `block` `boardFeet` `bolt` `book` `bottle` `box` `bulk` `bundle` `bushel` `cake` `can` `card` `carton` `cartridge` `case` `cassette` `celsius` `cell` `centigram` `centiliter` `centimeter` `coil` `combo` `cone` `container` `count` `cover` `display` `dozen` `drum` `each` `flakeTon` `foot` `gallon` `gram` `gramsPerLiter` `inch` `kilogram` `kit` `knots` `linearFoot` `liter` `meter` `milliliter` `monetaryValue` `ocularInsertSystem` `order` `ounce` `packPAK` `package` `pad` `pail` `pair` `pairInches` `palletLift` `palletUnitLoad` `person` `piece` `pint` `pound` `poundEquivalent` `poundGross` `quart` `reel` `roll` `section` `set` `sheet` `sixPack` `squareFoot` `syringe` `thousand` `threePack` `tote` `tube` `unit` `vial`
overShipmentshow child fieldshide child fields	object		Quantity shipped in excess of the ordered quantity
value	string	✓	Numeric quantity value
unitOfMeasure	string		Unit of measure for the quantity Values: `assembly` `assortment` `bag` `bale` `ball` `bar` `barrel` `belt` `bin` `block` `boardFeet` `bolt` `book` `bottle` `box` `bulk` `bundle` `bushel` `cake` `can` `card` `carton` `cartridge` `case` `cassette` `celsius` `cell` `centigram` `centiliter` `centimeter` `coil` `combo` `cone` `container` `count` `cover` `display` `dozen` `drum` `each` `flakeTon` `foot` `gallon` `gram` `gramsPerLiter` `inch` `kilogram` `kit` `knots` `linearFoot` `liter` `meter` `milliliter` `monetaryValue` `ocularInsertSystem` `order` `ounce` `packPAK` `package` `pad` `pail` `pair` `pairInches` `palletLift` `palletUnitLoad` `person` `piece` `pint` `pound` `poundEquivalent` `poundGross` `quart` `reel` `roll` `section` `set` `sheet` `sixPack` `squareFoot` `syringe` `thousand` `threePack` `tote` `tube` `unit` `vial`
invoiceTotal	string		Total amount of the invoice
invoiceSalesTotal	string		Sales total used to calculate terms discount amount
invoiceTermsDiscount	string		Terms discount amount applied to the invoice
taxesshow child fieldshide child fields	object		Tax information for the invoice
harmonizedSalesTaxshow child fieldshide child fields	object		Harmonized sales tax (HST) information
amount	string		Tax amount
percent	string		Tax percentage rate
taxIdNumber	string		Tax identification number
locationId	string		Tax location identifier
exemptionCode	string		Tax exemption status Values: `exempt` `notExempt` `notTaxable`
jurisdictionType	string		Type of tax jurisdiction
jurisdictionCode	string		Tax jurisdiction code
assignedId	string		Assigned tax identifier — partner-internal accounting reference for this tax line
goodsAndServicesTaxshow child fieldshide child fields	object		Goods and services tax (GST) or value-added tax (VAT) information
amount	string		Tax amount
percent	string		Tax percentage rate
taxIdNumber	string		Tax identification number
locationId	string		Tax location identifier
exemptionCode	string		Tax exemption status Values: `exempt` `notExempt` `notTaxable`
jurisdictionType	string		Type of tax jurisdiction
jurisdictionCode	string		Tax jurisdiction code
assignedId	string		Assigned tax identifier — partner-internal accounting reference for this tax line
stateProvincialTaxshow child fieldshide child fields	object		State or provincial sales tax information
amount	string		Tax amount
percent	string		Tax percentage rate
taxIdNumber	string		Tax identification number
locationId	string		Tax location identifier
exemptionCode	string		Tax exemption status Values: `exempt` `notExempt` `notTaxable`
jurisdictionType	string		Type of tax jurisdiction
jurisdictionCode	string		Tax jurisdiction code
assignedId	string		Assigned tax identifier — partner-internal accounting reference for this tax line
stateProvincialGoodsTaxshow child fieldshide child fields	object		State or provincial goods tax information
amount	string		Tax amount
percent	string		Tax percentage rate
taxIdNumber	string		Tax identification number
locationId	string		Tax location identifier
exemptionCode	string		Tax exemption status Values: `exempt` `notExempt` `notTaxable`
jurisdictionType	string		Type of tax jurisdiction
jurisdictionCode	string		Tax jurisdiction code
assignedId	string		Assigned tax identifier — partner-internal accounting reference for this tax line
localTaxshow child fieldshide child fields	object		Local tax information
amount	string		Tax amount
percent	string		Tax percentage rate
taxIdNumber	string		Tax identification number
locationId	string		Tax location identifier
exemptionCode	string		Tax exemption status Values: `exempt` `notExempt` `notTaxable`
jurisdictionType	string		Type of tax jurisdiction
jurisdictionCode	string		Tax jurisdiction code
assignedId	string		Assigned tax identifier — partner-internal accounting reference for this tax line
allowancesshow child fieldshide child fields	array		Allowances or discounts applied to the invoice
type	string	✓	Type of allowance or charge Values: `advertising` `defectiveAllowance` `discount` `freight` `handling` `newStore` `other` `promotionalAllowance` `quantityDiscount` `rebate` `restocking` `serviceAtPickupOrDelivery` `shipping` `shippingAndHandling` `swell` `unsaleableMerchandiseAllowance` `volume` `warehouse`
amount	string		Fixed amount of allowance or charge
percent	string		Percentage of allowance or charge
percentBasis	string		Basis for calculating percentage Values: `basePrice`
methodOfHandling	string		How the charge is handled Values: `collect` `paidByVendor` `paidByCustomer` `prepaid`
description	string		Description of the allowance or charge
chargesshow child fieldshide child fields	array		Additional charges applied to the invoice
type	string	✓	Type of allowance or charge Values: `advertising` `defectiveAllowance` `discount` `freight` `handling` `newStore` `other` `promotionalAllowance` `quantityDiscount` `rebate` `restocking` `serviceAtPickupOrDelivery` `shipping` `shippingAndHandling` `swell` `unsaleableMerchandiseAllowance` `volume` `warehouse`
amount	string		Fixed amount of allowance or charge
percent	string		Percentage of allowance or charge
percentBasis	string		Basis for calculating percentage Values: `basePrice`
methodOfHandling	string		How the charge is handled Values: `collect` `paidByVendor` `paidByCustomer` `prepaid`
description	string		Description of the allowance or charge

{
  "type": "810_INVOICE",
  "stream": "test",
  "senderId": "SELLERISA",
  "receiverId": "BUYERISA",
  "message": {
    "invoiceDate": "2026-02-22",
    "invoiceNumber": "INV-2026-0222-4875905",
    "purchaseOrderNumber": "PO5786344061670677",
    "releaseNumber": "004010",
    "references": {
      "vendorNumber": {
        "value": "4875905"
      },
      "departmentNumber": {
        "value": "011"
      },
      "billOfLadingNumber": {
        "value": "BOL-2026-0219-001"
      },
      "proNumber": {
        "value": "PRO7742859301"
      },
      "shipmentId": {
        "value": "SHP-2026-0219-4875905"
      }
    },
    "dates": {
      "shipDate": "2026-02-19",
      "deliveryDate": "2026-02-21"
    },
    "parties": {
      "buyer": {
        "name": "Retail Integration Testing",
        "identificationCode": "5438",
        "identificationCodeType": "receiversId"
      },
      "shipTo": {
        "name": "Retail Integration Testing",
        "identificationCode": "5438",
        "identificationCodeType": "receiversId",
        "addressLine1": "4055 MAIN ST",
        "city": "NEW YORK",
        "stateOrProvinceCode": "NY",
        "postalCode": "10001",
        "countryCode": "US"
      },
      "billTo": {
        "name": "Retail Integration Testing",
        "identificationCode": "5438",
        "identificationCodeType": "receiversId",
        "addressLine1": "4055 MAIN ST",
        "city": "NEW YORK",
        "stateOrProvinceCode": "NY",
        "postalCode": "10001",
        "countryCode": "US"
      },
      "accountsReceivable": {
        "name": "Toothpaste Co.",
        "identificationCode": "4875905",
        "identificationCodeType": "sendersId",
        "addressLine1": "500 Oral Care Blvd",
        "city": "Newark",
        "stateOrProvinceCode": "NJ",
        "postalCode": "07102",
        "countryCode": "US",
        "contacts": [
          {
            "type": "primary",
            "name": "Accounts Receivable",
            "phoneNumber": "973-555-0300",
            "email": "[email protected]"
          }
        ]
      }
    },
    "termsOfSale": {
      "type": "basic",
      "basisDate": "deliveryDate",
      "discountPercent": "1",
      "discountDaysDue": 45,
      "description": "Net 45 Days"
    },
    "carrierDetails": {
      "quantityAndWeight": [
        {
          "packageForm": "carton",
          "ladingQuantity": "4",
          "weightUOM": "pound",
          "grossWeight": "285.00"
        }
      ],
      "routing": [
        {
          "sequenceType": "origin",
          "standardCarrierAlphaCode": "FEDX",
          "transportationMethod": "commonCarrier",
          "serviceLevel": "ground"
        }
      ],
      "equipment": {
        "equipmentType": "trailer",
        "equipmentId": "FEDX-TRL-88412"
      },
      "freeOnBoard": [
        {
          "methodOfPayment": "mutuallyAgreed"
        }
      ]
    },
    "lineItems": [
      {
        "purchaseOrderLineId": "1",
        "quantityInvoiced": {
          "value": "5",
          "unitOfMeasure": "each"
        },
        "unitPrice": "101.00",
        "productIds": {
          "buyerItemNumber": "10000002",
          "gtin12": "002837465832"
        },
        "productAttributes": {
          "description": "Green toothpaste"
        },
        "outerPack": {
          "numberOfUnits": "10"
        },
        "innerPack": {
          "numberOfUnits": "10"
        }
      },
      {
        "purchaseOrderLineId": "2",
        "quantityInvoiced": {
          "value": "20",
          "unitOfMeasure": "each"
        },
        "unitPrice": "88.00",
        "productIds": {
          "buyerItemNumber": "10000004",
          "gtin12": "002837465837"
        },
        "productAttributes": {
          "description": "Orange toothpaste"
        },
        "outerPack": {
          "numberOfUnits": "8"
        },
        "innerPack": {
          "numberOfUnits": "8"
        }
      },
      {
        "purchaseOrderLineId": "4",
        "quantityInvoiced": {
          "value": "10",
          "unitOfMeasure": "each"
        },
        "unitPrice": "95.00",
        "productIds": {
          "buyerItemNumber": "10000001",
          "gtin12": "002837465831"
        },
        "productAttributes": {
          "description": "Yellow toothpaste"
        },
        "outerPack": {
          "numberOfUnits": "10"
        },
        "innerPack": {
          "numberOfUnits": "10"
        }
      },
      {
        "purchaseOrderLineId": "5",
        "quantityInvoiced": {
          "value": "5",
          "unitOfMeasure": "each"
        },
        "unitPrice": "19.99",
        "productIds": {
          "buyerItemNumber": "ORDERFUL-TEST-SKU-005A",
          "gtin12": "012345678015"
        },
        "productAttributes": {
          "description": "Placeholder product for scenario testing"
        },
        "outerPack": {
          "numberOfUnits": "1"
        },
        "innerPack": {
          "numberOfUnits": "1"
        }
      }
    ],
    "allowances": [
      {
        "type": "discount",
        "amount": "165.75",
        "description": "Discount"
      }
    ],
    "charges": [
      {
        "type": "freight",
        "amount": "784.99",
        "description": "Freight Charge"
      }
    ],
    "invoiceSalesTotal": "3314.95",
    "invoiceTermsDiscount": "33.15",
    "invoiceTotal": "3934.19"
  }
}

File	Description	Download
sample.json	Sample JSON payload	Download
schema.json	JSON Schema for validation	Download