An Invoice is sent by a supplier to bill for goods or services that have been shipped.
| 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 |
releaseNumber |
string | Release number for blanket or contract orders | |
notes |
object | General notes or comments | |
general |
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 | |
buyersCurrency |
object | Currency used by the buyer | |
currencyCode |
string | ✓ | ISO currency code (e.g., USD, EUR) |
exchangeRate |
string | Exchange rate for currency conversion | |
sellersCurrency |
object | Currency used by the seller | |
currencyCode |
string | ✓ | ISO currency code (e.g., USD, EUR) |
exchangeRate |
string | Exchange rate for currency conversion | |
references |
object | Reference numbers associated with the invoice | |
customerOrderNumber |
object | Customer-assigned order number | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
divisionId |
object | Business division identifier | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
departmentNumber |
object | Department number within the organization | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
vendorNumber |
object | Vendor or supplier identifier | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
promotionNumber |
object | Promotional campaign or deal identifier | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
thirdPartyReferenceNumber |
object | Reference number from a third-party system | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
relatedInvoiceNumber |
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 | |
returnAuthorizationNumber |
object | Return merchandise authorization (RMA) number | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
jobNumber |
object | Job or project number | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
billOfLadingNumber |
object | Bill of lading number for the shipment | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
proNumber |
object | Progressive or PRO number from the carrier | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
trackingNumber |
object | Shipment tracking number | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
shipmentId |
object | Unique shipment identifier | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
dates |
object | Date the goods were shipped | |
shipDate |
unknown | Date the goods were shipped | |
deliveryDate |
unknown | Date the goods were delivered | |
parties |
object | Buying party who purchased the goods | |
buyer |
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 | N103: Codes 91 and 92 are specific to the direction of the transaction.
Retail Example: For the 850 92 maps to sender and 91 maps to receiver.
For the 856, 810 - sender maps to 91 and receiver maps to 92 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 |
|
contacts |
array | Contact persons for this party | |
type |
string | ✓ | 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. | |
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. | |
shipTo |
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 | N103: Codes 91 and 92 are specific to the direction of the transaction.
Retail Example: For the 850 92 maps to sender and 91 maps to receiver.
For the 856, 810 - sender maps to 91 and receiver maps to 92 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 |
|
contacts |
array | Contact persons for this party | |
type |
string | ✓ | 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. | |
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. | |
billTo |
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 | N103: Codes 91 and 92 are specific to the direction of the transaction.
Retail Example: For the 850 92 maps to sender and 91 maps to receiver.
For the 856, 810 - sender maps to 91 and receiver maps to 92 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 |
|
contacts |
array | Contact persons for this party | |
type |
string | ✓ | 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. | |
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. | |
accountsReceivable |
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 | N103: Codes 91 and 92 are specific to the direction of the transaction.
Retail Example: For the 850 92 maps to sender and 91 maps to receiver.
For the 856, 810 - sender maps to 91 and receiver maps to 92 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 |
|
contacts |
array | Contact persons for this party | |
type |
string | ✓ | 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. | |
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. | |
accountsPayable |
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 | N103: Codes 91 and 92 are specific to the direction of the transaction.
Retail Example: For the 850 92 maps to sender and 91 maps to receiver.
For the 856, 810 - sender maps to 91 and receiver maps to 92 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 |
|
contacts |
array | Contact persons for this party | |
type |
string | ✓ | 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. | |
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. | |
termsOfSale |
object | Payment terms and conditions | |
type |
string | Values: basic basicDiscountOffered discountNotApplicable endOfMonth endOfMonth10 extended instant fixedDate proximo mutuallyDefined |
|
basisDate |
string | 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 | Values: check letterOfCredit wireTransfer corporateTradePayment specialAccount directPayOthers |
|
carrierDetails |
object | Quantity and weight details for the shipment | |
quantityAndWeight |
array | Quantity and weight details for the shipment | |
packageForm |
string | Values: bag carton case coil pallet |
|
packageMaterial |
string | 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 | Values: cubicFeet cubicInches cubicMeter cubicYard gallon liter |
|
dimensionUOM |
string | 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 | |
ladingQuantity |
string | Unit count based on the package form (e.g., number of cartons or pallets) | |
routing |
array | Carrier routing and transportation details | |
sequenceType |
string | Values: origin 1stAfterOrigin 4thAfterOrigin haulage |
|
standardCarrierAlphaCode |
string | SCAC code identifying the carrier | |
customCarrierCode |
string | Custom carrier identifier | |
transportationMethod |
string | Values: air airExpress airFreightForward backhaul bestWay commonCarrier consolidation customerPickup expeditedTruck lessThanTrailerLoad mail ocean oceanContainerized parcelPost privateCarrier rail shipperAgent supplierTruck trailer mutuallyDefined |
|
locationType |
string | Values: inStore receiversLocation allPoints portOfArrival portOfEmbarkation origin mutuallyDefined |
|
location |
string | Routing location identifier or name | |
description |
string | Description of routing details | |
serviceLevel |
string | 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 | Values: shipCompleteOnDate complete partialShipment shipPartialBackorderToShipOnDate partialShipOnDate shipped backordered mutuallyDefined availableScheduledToShip availableNoShipSchedule multiPickup availableToShipUnBilledQuantity stopOff |
|
transitDirectionType |
string | Values: buyerToSeller sellerToBuyer subcontractorToSeller sellerToDropShipLocation sellToForwarder sellerToSubcontractor mutuallyDefined |
|
transitTimeType |
string | These may be sent on the PO but for Outbound we can calculate based on shipDate and deliveryDate Values: calendarDays hours workingDays |
|
transitTime |
string | Expected transit time value | |
equipment |
object | Equipment details such as trailer information | |
equipmentType |
string | Values: container reefer trailer oceanVessel |
|
equipmentId |
string | Equipment identifier (e.g., trailer number) | |
sealNumber |
string | Seal number for security verification | |
freeOnBoard |
array | FOB (Free on Board) terms and conditions | |
methodOfPayment |
string | Values: airCollect airPrepaid paidByBuyer collect mutuallyAgreed portOfCall halfPrepaid mixed serviceFreightNoCharge advancePrepaid customerPickupBackhaul prepaidChargeCustomer prepaidBySeller paidBySeller pickup thirdPartyPay |
|
locationType |
string | Values: cityAndState country destination origin stateProvince warehouse |
|
locationDescription |
string | Description of FOB location | |
titlePassageType |
string | Values: cityAndState country destination origin stateProvince warehouse |
|
titlePassageDescription |
string | Description of title passage location | |
transportationTermsSource |
string | Values: incoTerms tradeTerms mutuallyDefined |
|
transportationTerms |
string | 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 | Values: toDestinationBuyer toFreightEqPointSeller toPoolPointSeller toDestinationSeller mutuallyDefined |
|
description |
string | Additional FOB description | |
lineItems |
array | ✓ | Line items included in the invoice |
purchaseOrderLineId |
string | Line item identifier from the original purchase order | |
quantityInvoiced |
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 |
|
productIds |
object | ✓ | Product identification codes such as UPC, SKU, or vendor item number |
buyerItemNumber |
string | Buyer-assigned item number | |
vendorItemNumber |
string | Vendor-assigned 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 | |
buyerItemIds |
array | Additional buyer product identifiers | |
type |
string | ✓ | Values: catalog manufacturerPart sku style |
value |
string | ✓ | Product identifier value |
vendorItemIds |
array | Additional vendor product identifiers | |
type |
string | ✓ | Values: catalog manufacturerPart sku style |
value |
string | ✓ | Product identifier value |
productAttributes |
object | Product attributes such as color, size, and description | |
description |
string | General product description | |
shortDescription |
string | 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 | |
materialAttributes |
object | Material type or classification | |
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 | 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 | |
outerPack |
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 | Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit |
|
packageForm |
string | Values: bag bottle box can carton coil container pallet shrinkWrap unit |
|
packageMaterial |
string | 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 | 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 | 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 | |
baseboxBasisWeight |
string | Basis weight in pounds per base box — the standard steel mill weight specification unit | |
innerPack |
object | Physical details for the inner packaging | |
numberOfUnits |
string | Number of units in the package | |
size |
string | Size value of the package | |
sizeUOM |
string | Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit |
|
packageForm |
string | Values: bag bottle box can carton coil container pallet shrinkWrap unit |
|
packageMaterial |
string | 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 | 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 | 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 | |
baseboxBasisWeight |
string | Basis weight in pounds per base box — the standard steel mill weight specification unit | |
references |
object | Reference numbers for this line item | |
returnAuthorizationNumber |
object | Return merchandise authorization number | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
billOfLadingNumber |
object | Bill of lading number for this line item | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
proNumber |
object | PRO number from the carrier | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
trackingNumber |
object | Tracking number for this line item | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
shipmentId |
object | Shipment identifier for this line item | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
allowances |
array | Allowances or discounts for this line item | |
type |
string | ✓ | 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 | Values: collect paidByVendor paidByCustomer prepaid |
|
description |
string | Description of the allowance or charge | |
charges |
array | Additional charges for this line item | |
type |
string | ✓ | 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 | Values: collect paidByVendor paidByCustomer prepaid |
|
description |
string | Description of the allowance or charge | |
carrierDetails |
object | Carrier routing information | |
routing |
array | Carrier routing information | |
sequenceType |
string | Values: origin 1stAfterOrigin 4thAfterOrigin haulage |
|
standardCarrierAlphaCode |
string | SCAC code identifying the carrier | |
customCarrierCode |
string | Custom carrier identifier | |
transportationMethod |
string | Values: air airExpress airFreightForward backhaul bestWay commonCarrier consolidation customerPickup expeditedTruck lessThanTrailerLoad mail ocean oceanContainerized parcelPost privateCarrier rail shipperAgent supplierTruck trailer mutuallyDefined |
|
locationType |
string | Values: inStore receiversLocation allPoints portOfArrival portOfEmbarkation origin mutuallyDefined |
|
location |
string | Routing location identifier or name | |
description |
string | Description of routing details | |
serviceLevel |
string | 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 | Values: shipCompleteOnDate complete partialShipment shipPartialBackorderToShipOnDate partialShipOnDate shipped backordered mutuallyDefined availableScheduledToShip availableNoShipSchedule multiPickup availableToShipUnBilledQuantity stopOff |
|
transitDirectionType |
string | Values: buyerToSeller sellerToBuyer subcontractorToSeller sellerToDropShipLocation sellToForwarder sellerToSubcontractor mutuallyDefined |
|
transitTimeType |
string | These may be sent on the PO but for Outbound we can calculate based on shipDate and deliveryDate Values: calendarDays hours workingDays |
|
transitTime |
string | Expected transit time value | |
sublineItems |
array | Subline items for component or kit details | |
sublineId |
string | Subline item identifier | |
quantity |
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 |
|
productIds |
object | ✓ | Product identifiers for the subline item |
buyerItemNumber |
string | Buyer-assigned item number | |
vendorItemNumber |
string | Vendor-assigned 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 | |
buyerItemIds |
array | Additional buyer product identifiers | |
type |
string | ✓ | Values: catalog manufacturerPart sku style |
value |
string | ✓ | Product identifier value |
vendorItemIds |
array | Additional vendor product identifiers | |
type |
string | ✓ | Values: catalog manufacturerPart sku style |
value |
string | ✓ | Product identifier value |
productAttributes |
object | Product attributes for the subline item | |
description |
string | General product description | |
shortDescription |
string | 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 | |
materialAttributes |
object | Material type or classification | |
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 | 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 | |
additionalQuantities |
object | Quantity shipped for this line item | |
shipped |
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 |
|
partialShipment |
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 |
|
backOrdered |
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 |
|
unavailable |
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 |
|
canceled |
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 |
|
substitution |
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 |
|
overShipment |
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 | |
taxes |
object | Tax information for the invoice | |
harmonizedSalesTax |
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 | Values: exempt notExempt notTaxable |
|
jurisdictionType |
string | Type of tax jurisdiction | |
jurisdictionCode |
string | Tax jurisdiction code | |
assignedId |
string | Assigned tax identifier | |
goodsAndServicesTax |
object | Goods and services tax (GST) information | |
amount |
string | Tax amount | |
percent |
string | Tax percentage rate | |
taxIdNumber |
string | Tax identification number | |
locationId |
string | Tax location identifier | |
exemptionCode |
string | Values: exempt notExempt notTaxable |
|
jurisdictionType |
string | Type of tax jurisdiction | |
jurisdictionCode |
string | Tax jurisdiction code | |
assignedId |
string | Assigned tax identifier | |
stateProvincialTax |
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 | Values: exempt notExempt notTaxable |
|
jurisdictionType |
string | Type of tax jurisdiction | |
jurisdictionCode |
string | Tax jurisdiction code | |
assignedId |
string | Assigned tax identifier | |
stateProvincialGoodsTax |
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 | Values: exempt notExempt notTaxable |
|
jurisdictionType |
string | Type of tax jurisdiction | |
jurisdictionCode |
string | Tax jurisdiction code | |
assignedId |
string | Assigned tax identifier | |
localTax |
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 | Values: exempt notExempt notTaxable |
|
jurisdictionType |
string | Type of tax jurisdiction | |
jurisdictionCode |
string | Tax jurisdiction code | |
assignedId |
string | Assigned tax identifier | |
allowances |
array | Allowances or discounts applied to the invoice | |
type |
string | ✓ | 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 | Values: collect paidByVendor paidByCustomer prepaid |
|
description |
string | Description of the allowance or charge | |
charges |
array | Additional charges applied to the invoice | |
type |
string | ✓ | 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 | 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"
}
}
