Sales Order Item
Schema
Relationships
- SalesOrder has zero to many SalesOrderItems
- SalesOrderItem has zero to many PriceElements
- PriceElement has zero to many ExtensionFields
- PriceElement has one PriceElementType
Data Definitions
| Data Type | Field Name | Rules | About |
|---|---|---|---|
| AttributeField | attributeField | Zero to Many | Refer to: Attribute Field |
| Product | catalogItem | Zero or One | Refer to: Product |
| Monetary | costAmount | Zero or One | Item price before markup, taxes etc. Disposition: Under consideration for deprecation. See Price Element |
| Monetary | discountAmount | Zero or One | Monetary amount to be deducted from the sales order item. Disposition: Under consideration for deprecation.See Price Element |
| Decimal | discountRate | Zero or One | Percentage to be deducted from the gross amount as a discount on this sales order item. Disposition: Under consideration for deprecation. See Price Element |
| ExtensionField | extendedBy | Zero to Many | Refer to: Extension Field |
| ExternalID | externalIdentity | Zero to Many | Refer to: External ID |
| Monetary | freightAmount | Zero or One | Disposition: Under consideration for deprecation. See Price Element |
| String | itemIdentifier | Zero or One | The customer-facing identifier for this item. |
| Monetary | grossAmount | Zero or One | Total amount for the line item, before any adjustments for the sale of the good or service. Disposition: Under consideration for deprecation. See Price Element |
| String | lineNumber | Zero or One | The number of this sales order item within the collection of sales order items on the parent sales order. |
| Monetary | listAmount | Exactly 1 | Listed price for this sales order item. Disposition: Under consideration for deprecation. See Price Element |
| Monetary | netAmount | Exactly 1 | The amount of money a company actually receives for this sales order item from a customer after any discounts, returns, or allowances have been applied. Disposition: Under consideration for deprecation. See Price Element |
| SalesOrderItemOverallStatus | overallStatus | Zero or One | External system status of the sales order item. (Open, In Progress, Complete) Refer to: Overall Status |
| Magnitude | quantity | Zero or One | Number of items requested for this sales order line item |
| RecordedByUser | recordedBy | Zero to Many | Reference to the record for the user who captured the sales order item in the originating system |
| Decimal | remainingQuantity | Zero or One | The quantity of a product or service that is still outstanding and has not yet been delivered or fulfilled to the customer as part of a sales order. |
| String | sourceSystemCode | Zero or One | Refer to: Source System |
| String | sourceSystemID | Zero or One | Refer to: Source System |
| Monetary | taxAmount | Zero or One | The monetary amount of the tax applied to the sales order item. |
| Decimal | taxRate | Zero or One | A percentage rate of the tax applied to the sales order item |
| TaxType | taxType | Zero or One | Description and reference of the tax applied to the Sales Order Item. Refer to: Tax Type |
| Monetary | unitAmount | Exactly 1 | Disposition: Under consideration for deprecation. See Price Element |
| Monetary | unitCostAmount | Exactly 1 | Disposition: Under consideration for deprecation. See Price Element |
| Monetary | unitFreightAmount | Exactly 1 | Disposition: Under consideration for deprecation. See Price Element |
| ScheduleLineItem | scheduleLineItem | Zero to Many | A collection of items documenting changes to actual delivery date vs original expected delivery date. Schedule Line Item |
| PriceElement | salesOrderPriceElement | Zero to Many | A collection of all the monetary movements recorded for this sales order item. Refer to: Price Element |
Sample JSON
A sample SalesOrderItem, as it would be contained within a SalesOrder, with multiple PriceElements for that SalesOrderItem.
"txDocItem": [
{
"@type": "SalesOrderItem",
"externalIdentity": [
{
"@type": "ExternalID",
"internalType": "SalesOrderItem",
"externalSystemCode": “ExternalSystemA1",
"externalId": "715"
}
],
"extendedBy": [
{
"@type": "ExtensionField",
"key": "isKit",
"value": [
"false"
],
"uniqueText": "535fe6a5-09a3-4743-9060-58a0c2f8e6e5"
}
],
"lineNumber": "1",
"grossAmount": {
},
"netAmount": {
},
"taxAmount": {
},
"taxType": "https://schema.limbergraph.com/limber/TaxType#GST_STANDARD_NZ",
"catalogItem": "https://schema.limbergraph.com/limber/Product#52454b20-82e5-4512-916a-5417dcdd499d",
"uniqueText": "690d651e-6510-475b-be69-228861f96650",
"priceElement":[
{
"adjustmentAmount":{
"@type": "Monetary",
"decimalValue": "11.00",
"currency": "https://schema.limbergraph.com/limber/CurrencyUnit#NZD",
"uniqueText": "1b2f0c8d-e8de-4c30-8162-149b36bd5b57"
},
"priceElementType": "https://schema.limbergraph.com/limber/
PriceElementType#LIST_AMOUNT",
"extendedBy": [
{
"@type": "ExtensionField",
"uniqueText": "f3b7c9a6-5a63-4f97-b35d-50158e65cef4",
"key": "conditionCode",
"value": [
"ZPR1"
]
},
],
},
{
"adjustmentAmount":{
"@type": "Monetary",
"decimalValue": "1.71",
"currency": "https://schema.limbergraph.com/limber/CurrencyUnit#NZD",
"uniqueText": "1b2f0c8d-e8de-4c30-8162-149b36bd5b57"
},
"priceElementType": "https://schema.limbergraph.com/limber/PriceElementType#MINIMUM_CHARGE",
"extendedBy": [
{
"@type": "ExtensionField",
"uniqueText": "f3b7c9a6-5a63-4f97-b35d-50158e65cef4",
"key": "conditionCode",
"value": [
"ZMNV"
]
},
],
},
{
"adjustmentAmount":{
"@type": "Monetary",
"decimalValue": "0.34",
"currency": "https://schema.limbergraph.com/limber/CurrencyUnit#NZD",
"uniqueText": "1b2f0c8d-e8de-4c30-8162-149b36bd5b57"
},
"priceElementType": "https://schema.limbergraph.com/limber/PriceElementType#MINIMUM_CHARGE",
"extendedBy": [
{
"@type": "ExtensionField",
"uniqueText": "f3b7c9a6-5a63-4f97-b35d-50158e65cef4",
"key": "conditionCode",
"value": [
"ZMNC"
]
},
],
},
{
"adjustmentAmount":{
"@type": "Monetary",
"decimalValue": "0.32",
"currency": "https://schema.limbergraph.com/limber/CurrencyUnit#NZD",
"uniqueText": "1b2f0c8d-e8de-4c30-8162-149b36bd5b57"
},
"priceElementType": "https://schema.limbergraph.com/limber/PriceElementType#HEADER_FREIGHT",
"extendedBy": [
{
"@type": "ExtensionField",
"uniqueText": "f3b7c9a6-5a63-4f97-b35d-50158e65cef4",
"key": "conditionCode",
"value": [
"ZBHD"
]
},
],
},
{
"adjustmentAmount":{
"@type": "Monetary",
"decimalValue": "0.00",
"currency": "https://schema.limbergraph.com/limber/CurrencyUnit#NZD",
"uniqueText": "1b2f0c8d-e8de-4c30-8162-149b36bd5b57"
},
"priceElementType": "https://schema.limbergraph.com/limber/PriceElementType#FREIGHT_ADMIN",
"extendedBy": [
{
"@type": "ExtensionField",
"uniqueText": "f3b7c9a6-5a63-4f97-b35d-50158e65cef4",
"key": "conditionCode",
"value": [
"ZFR1"
]
},
],
},
{
"adjustmentAmount":{
"@type": "Monetary",
"decimalValue": "0.00",
"currency": "https://schema.limbergraph.com/limber/CurrencyUnit#NZD",
"uniqueText": "1b2f0c8d-e8de-4c30-8162-149b36bd5b57"
},
"priceElementType": "https://schema.limbergraph.com/limber/PriceElementType#DOWN_PAYMENT",
"extendedBy": [
{
"@type": "ExtensionField",
"uniqueText": "f3b7c9a6-5a63-4f97-b35d-50158e65cef4",
"key": "conditionCode",
"value": [
"YZWR"
]
},
],
},
{
"adjustmentAmount":{
"@type": "Monetary",
"decimalValue": "1.68",
"currency": "https://schema.limbergraph.com/limber/CurrencyUnit#NZD",
"uniqueText": "1b2f0c8d-e8de-4c30-8162-149b36bd5b57"
},
"priceElementType": "https://schema.limbergraph.com/limber/PriceElementType#TAX",
"extendedBy": [
{
"@type": "ExtensionField",
"uniqueText": "f3b7c9a6-5a63-4f97-b35d-50158e65cef4",
"key": "conditionCode",
"value": [
"TTX1"
]
},
],
},
{
"adjustmentAmount":{
"@type": "Monetary",
"decimalValue": "51.72",
"currency": "https://schema.limbergraph.com/limber/CurrencyUnit#NZD",
"uniqueText": "1b2f0c8d-e8de-4c30-8162-149b36bd5b57"
},
"priceElementType": "https://schema.limbergraph.com/limber/PriceElementType#COST",
"extendedBy": [
{
"@type": "ExtensionField",
"uniqueText": "f3b7c9a6-5a63-4f97-b35d-50158e65cef4",
"key": "conditionCode",
"value": [
"PCIP"
]
},
],
},
]
}
],
"uniqueText": "35979a42-390e-479d-b75a-8792a750d6eb"
}