Sales Order
Summary
A Sales Order is a document that records a customer's request to purchase goods or services from a company. It includes information such as the customer's name, address, contact information, the items being ordered, the quantity of each item, the price of each item, and the total amount of the order.
Schema
Relationships
- SalesOrder contains zero or many SalesOrderItem
- SalesOrder has exactly one CustomerAccount
- SalesOrder has exactly one TaxType
- SalesOrderItem contains zero or many PriceElement
- SalesOrderItem contains zero or many ScheduleLineItem
- PriceElement contains zero or many Price Element Type
Data Definitions
SalesOrder
| Data Type | Field Name | Rules | About |
|---|---|---|---|
| AttributeField | attributeField | Zero to Many | [Attribute Field] |
| BusinessPartner | billTo | Zero or One | Internal reference to the business partner record of the party to receive billing information |
| BusinessPartner | businessPartner | One to Many | A list of all other potential business partners involved in the sales order |
| BusinessPartner | buyer | Exactly 1 | Internal reference to the business partner record of the Sold to party |
| string | buyerPoNumber | Zero or One | External purchase order number provided by the buyer |
| CustomerAccount | customerAccount | Exactly 1 | Document reference to the customer account document for which the order is placed. |
| DateTime | deliveryDate | Zero or One | Requested date time of delivery |
| ExtensionField | extendedBy | Zero to Many | Refer to: Extension Field |
| ExternalID | externalIdentity | Zero to Many | Refer to: External ID |
| Monetary | grossAmount | Zero or One | Total amount of an order for the sale of goods or services, before any adjustments. |
| Monetary | netAmount | Zero or One | The amount of money a company actually receives from a customer after any discounts, returns, or allowances have been applied. |
| DateTime | orderDate | Zero or One | The date and time the order was placed in the originating system |
| BusinessPartner | payer | Exactly 1 | Internal reference to the business partner record for the party responsible for payment |
| BusinessPartner | receiver | Exactly 1 | Internal reference to the business partner record for the party to who the goods will be delivered |
| RecordedByUser | recordedBy | Zero to Many | The user who captured the sales order in the originating system |
| BusinessPartner | salesEmployee | Zero or One | Internal reference to the business partner record of the sales representative responsible for the receiver business partner |
| BusinessPartner | seller | Exactly 1 | Internal reference to the business partner record for the sales organization |
| string | sourceSystemCode | Zero or One | Refer to: Source System |
| string | sourceSystemID | Zero or One | Refer to: Source System |
| Monetary | taxAmount | Zero or One | Monetary amount of tax applied to the sales order |
| TaxType | taxType | Zero or One | Document Reference to the TaxType document describing the tax applied to the Sales Order. |
| string | transactionNumber | Zero or One | Business defined canonical user facing sales order number. |
| SalesOrderItem | txDocument | Zero to Many | A collection of all the items included in the sales order. |
Sample JSON
{
"@type": "SalesOrder",
"externalIdentity": [
{
"@type": "ExternalID",
"internalType": "SalesOrder",
"externalSystemCode": "OurExternalSystem1",
"externalId": "130"
},
{
"@type": "ExternalID",
"internalType": "SalesOrder",
"externalSystemCode": "OurExternalSystem2",
"externalId": "ABC"
}
],
"transactionNumber": "TransactionNumber-130",
"netAmount": {
"@type": "Monetary",
"decimalValue": 452,
"uniqueText": "380e3a73-33f8-4bc9-9abd-ea1f07ef6eaa",
"currency": "https://schema.limbergraph.com/limber/CurrencyUnit#NZD"
},
"buyerPoNumber": "202203181050",
"deliveryDate": "2022-03-17T21:50:31Z",
"orderDate": "2022-03-17T21:50:31Z",
"sourceSystemCode": "OurExternalSystem1",
"sourceSystemId": "130",
"buyer": {
"@type": "InternalReference",
"id": "22b64325-1c8b-4068-8e2d-bb1eff547e0f",
"className": "BusinessPartner",
"externalIdentities": [
{
"integrationKey": "NzSl",
"externalId": "aed8e6d7-f1a5-48aa-9ff8-ee0f6b3b9bef"
}
],
"keys": [
{
"uniqueText": "22b64325-1c8b-4068-8e2d-bb1eff547e0f"
}
]
},
"payer": {
"@type": "InternalReference",
"id": "22b64325-1c8b-4068-8e2d-bb1eff547e0f",
"className": "BusinessPartner",
"externalIdentities": [
{
"integrationKey": "NzSl",
"externalId": "aed8e6d7-f1a5-48aa-9ff8-ee0f6b3b9bef"
}
],
"keys": [
{
"uniqueText": "22b64325-1c8b-4068-8e2d-bb1eff547e0f"
}
]
},
"receiver": {
"@type": "InternalReference",
"id": "66be9b2c-d86d-4525-9d39-4a36af6211b1",
"className": "BusinessPartner",
"externalIdentities": [
{
"integrationKey": "NzSl",
"externalId": "52e4a5b9-7c3a-482f-91bf-df40964bd14d"
},
{
"integrationKey": "NZIntegrationB2B",
"externalId": "875786"
}
],
"keys": [
{
"uniqueText": "66be9b2c-d86d-4525-9d39-4a36af6211b1"
}
]
},
"seller": {
"@type": "InternalReference",
"id": "97ea228b-cfab-43c6-a113-900daeb4b73b",
"className": "BusinessPartner",
"externalIdentities": [
{
"integrationKey": "NzSl",
"externalId": "NZCG"
}
],
"keys": [
{
"uniqueText": "97ea228b-cfab-43c6-a113-900daeb4b73b"
}
]
},
"customerAccount": "https://schema.limbergraph.com/limber/CustomerAccount#9276be12-f1c0-4647-997d-7e2ae485d9bd",
"businessPartner": [
{
"@type": "BusinessPartner",
"uniqueText": "22b64325-1c8b-4068-8e2d-bb1eff547e0f",
"externalIdentity": [
{
"@type": "ExternalID",
"internalType": "BusinessPartner",
"externalSystemCode": "NzSl",
"externalId": "aed8e6d7-f1a5-48aa-9ff8-ee0f6b3b9bef"
}
],
"extendedBy": [
{
"@type": "ExtensionField",
"uniqueText": "bb388da7-1286-449f-a97d-f9b1164c5f87",
"key": "externalSystemCustomerNumber",
"value": ["2372-0"]
},
{
"@type": "ExtensionField",
"uniqueText": "654e0299-5734-483e-9fc5-87c6c9d2eaf5",
"key": "siteCode",
"value": ["Auck"]
},
{
"@type": "ExtensionField",
"uniqueText": "149fb2a7-6513-4712-860d-f6ee6369f2fb",
"key": "shipSite",
"value": ["auck"]
},
{
"@type": "ExtensionField",
"uniqueText": "820709b1-b35c-48aa-aa1f-9dcd0389f211",
"key": "priceCode",
"value": ["CBR"]
}
],
"emailAddress": {
"@type": "EmailAddress",
"uniqueText": "da97fba3-81d0-4a96-a9fa-cfa6e2b65972",
"email": "[email protected]"
},
"phoneAddress": {
"@type": "PhoneAddress",
"uniqueText": "4320b5d5-590a-4ca1-abcb-6e2fb54ea680",
"addressType": "https://schema.limbergraph.com/limber/PhoneAddressType#Phone",
"phoneNumber": "555 123 4567"
},
"physicalAddress": {
"@type": "PhysicalAddress",
"uniqueText": "a8283b40-5d68-4f04-8199-499d998e7180",
"extendedBy": [],
"line1": "Company Name",
"line2": "PO Box 999",
"regionName": "WAI",
"postalCode": "3443",
"cityName": "Putaruru",
"country": "https://schema.limbergraph.com/limber/Country#NZ"
},
"primaryName": "Company Name Here",
"businessPartnerRole": [
"https://schema.limbergraph.com/limber/BusinessPartnerRole#Payer",
"https://schema.limbergraph.com/limber/BusinessPartnerRole#Buyer"
]
},
{
"@type": "BusinessPartner",
"uniqueText": "66be9b2c-d86d-4525-9d39-4a36af6211b1",
"externalIdentity": [
{
"@type": "ExternalID",
"internalType": "BusinessPartner",
"externalSystemCode": "NzSl",
"externalId": "52e4a5b9-7c3a-482f-91bf-df40964bd14d"
},
{
"@type": "ExternalID",
"internalType": "BusinessPartner",
"externalSystemCode": "NZBeddingPortalBundleB2B",
"externalId": "875786"
}
],
"extendedBy": [
{
"@type": "ExtensionField",
"uniqueText": "8f69ca07-4bc5-4f68-99da-6f9bcee6532c",
"key": "externalSystemCustomerNumber",
"value": ["2372-1"]
},
{
"@type": "ExtensionField",
"uniqueText": "869dd8af-894c-49bd-a836-92c9e31c9015",
"key": "isPortalCustomer",
"value": ["true"]
},
{
"@type": "ExtensionField",
"uniqueText": "56019088-f68f-4b73-bde1-109e66a21993",
"key": "siteCode",
"value": ["Auck"]
},
{
"@type": "ExtensionField",
"uniqueText": "48761034-62e3-47fd-9f66-071077d235b0",
"key": "shipSite",
"value": ["auck"]
}
],
"physicalAddress": {
"@type": "PhysicalAddress",
"uniqueText": "3e1e50fd-0b92-40bc-90e9-3a5f3db167c4",
"extendedBy": [
{
"@type": "ExtensionField",
"uniqueText": "b3ee55d8-8ed0-47ec-960f-f9d6b5787659",
"key": "houseNumber",
"value": ["34"]
},
{
"@type": "ExtensionField",
"uniqueText": "06bf86b5-ead4-41d4-a112-48ae7889a39d",
"key": "streetSuffixName",
"value": ["34"]
}
],
"line1": "34 Some Street",
"regionName": "WAI",
"postalCode": "3200",
"cityName": "Somewhere",
"country": "https://schema.limbergraph.com/limber/Country#NZ"
},
"primaryName": "Bed Company",
"businessPartnerRole": [
"https://schema.limbergraph.com/limber/BusinessPartnerRole#Receiver"
]
},
{
"@type": "BusinessPartner",
"uniqueText": "97ea228b-cfab-43c6-a113-900daeb4b73b",
"externalIdentity": [
{
"@type": "ExternalID",
"internalType": "BusinessPartner",
"externalSystemCode": "NzSl",
"externalId": "NZCG"
}
],
"primaryName": "Another Company",
"businessPartnerRole": [
"https://schema.limbergraph.com/limber/BusinessPartnerRole#Seller"
]
}
],
"txDocItem": [
{
"@type": "SalesOrderItem",
"externalIdentity": [
{
"@type": "ExternalID",
"internalType": "SalesOrderItem",
"externalSystemCode": "NZBeddingPortalBC",
"externalId": "32"
}
],
"extendedBy": [],
"lineNumber": "1",
"grossAmount": {
"@type": "Monetary",
"decimalValue": 519.8,
"uniqueText": "b4017b7d-a3e3-4822-9c36-e3467020a15d",
"currency": "https://schema.limbergraph.com/limber/CurrencyUnit#NZD"
},
"netAmount": {
"@type": "Monetary",
"decimalValue": 452,
"uniqueText": "e6e1fb9e-3548-4a67-accb-ed08cd3d3bb9",
"currency": "https://schema.limbergraph.com/limber/CurrencyUnit#NZD"
},
"taxAmount": {
"@type": "Monetary",
"decimalValue": 67.8,
"uniqueText": "dfbcd687-d0d3-4dd6-a734-e2a96c0e836d",
"currency": "https://schema.limbergraph.com/limber/CurrencyUnit#NZD"
},
"taxType": "https://schema.limbergraph.com/limber/TaxType#GST_STANDARD_NZ",
"catalogItem": "https://schema.limbergraph.com/limber/Product#893db725-76d9-4f14-9030-b5914283a299",
"costAmount": {
"@type": "Monetary",
"decimalValue": 0,
"uniqueText": "86e9d2f8-aebc-4c22-b443-e938752ae8ec",
"currency": "https://schema.limbergraph.com/limber/CurrencyUnit#NZD"
},
"listAmount": {
"@type": "Monetary",
"decimalValue": 452,
"uniqueText": "6c28a0ac-2d41-46cf-9b45-a98e172c07f9",
"currency": "https://schema.limbergraph.com/limber/CurrencyUnit#NZD"
},
"quantity": {
"@type": "Magnitude",
"decimalValue": 1,
"uom": "https://schema.limbergraph.com/limber/UnitOfMeasure#each",
"uniqueText": "99e3543a-3366-46a2-82f6-dba776d868be"
},
"unitAmount": {
"@type": "Monetary",
"decimalValue": 452,
"uniqueText": "cee9aeb1-7ebe-4800-a733-9d3ef9f3b4e1",
"currency": "https://schema.limbergraph.com/limber/CurrencyUnit#NZD"
},
"unitCostAmount": {
"@type": "Monetary",
"decimalValue": 0,
"uniqueText": "e5724827-094b-49eb-9b52-728f7d7699c4",
"currency": "https://schema.limbergraph.com/limber/CurrencyUnit#NZD"
},
"uniqueText": "4deeb144-2553-4041-a514-1242db160f29"
}
],
"uniqueText": "8ba0a038-79f0-422f-a84b-0d0fa1e618c1"
}