SalesOrder
SalesOrders. Represents a Sales Order header.
type SalesOrder {
orderNbr: String!
orderType: String!
projectId: Int
printDescriptionOnInvoice: Boolean
printNoteOnExternalDocuments: Boolean
printNoteOnInternalDocuments: Boolean
customerId: Int!
soBillingContactId: Int
templateStatus: String
soBillingAddressOverrideAddress: Boolean!
soBillingAddressId: Int
soBillingAddressLine1: String
soBillingAddressLine2: String
soBillingAddressLine3: String
soBillingAddressPostalCode: String
soBillingAddressCity: String
soBillingAddressCountryId: String
soBillingAddressCountyId: String
branchId: Int
customerVatZoneId: String
invoiceSeparately: Boolean!
invoiceNbr: String
invoiceDate: DateTime
creditTermsId: String
dueDate: DateTime
cashDiscountDate: DateTime
postPeriod: String
salesPersonId: Int
ownerId: UUID
origOrderType: String
origOrderNbr: String
soShippingContactId: Int
soShippingContactName: String
soShippingAddressOverrideAddress: Boolean!
soShippingAddressId: Int
soShippingAddressLine1: String
soShippingAddressLine2: String
soShippingAddressLine3: String
soShippingAddressPostalCode: String
soShippingAddressCity: String
soShippingAddressCountryId: String
soShippingAddressCountyId: String
scheduledShipmentDate: DateTime
shipSeparately: Boolean!
shipComplete: String!
cancelBy: DateTime
canceled: Boolean
preferredWarehouseId: Int
shipViaCarrierId: String
fobPointId: String
fobPointDescription: String
priority: Short!
shippingTermsId: String
shippingTermsDescription: String
shippingZoneId: String
shippingZoneDescription: String
residentialDelivery: Boolean!
saturdayDelivery: Boolean!
insurance: Boolean!
transactionTypeId: Int
transactionTypeDescription: String
status: String
hold: Boolean!
date: DateTime!
requestOn: DateTime
customerOrder: String
customerRefNbr: String
contactId: Int
locationId: Int
currency: String
description: String
orderTotal: Decimal!
vatTaxableTotal: Decimal!
vatExemptTotal: Decimal!
taxTotal: Decimal!
note: String
lastModifiedDateTime: DateTime!
exchangeRate: Decimal!
orderTotalInBaseCurrency: Decimal!
locationCountryId: String
orderQty: Decimal!
deletedDatabaseRecord: Boolean!
companyId: Int!
id: String!
createdInDataMartDateTime: DateTime!
updatedInDataMartDateTime: DateTime!
}
Fields
SalesOrder.orderNbr ● String! non-null scalar
orderNbr > (PK) The reference number of the sales order.
SalesOrder.orderType ● String! non-null scalar
orderType > (PK) The type of the document, which is one of the predefined order types or a custom order type.
SalesOrder.projectId ● Int scalar
projectId > The identifier for the project with which this document is associated.
SalesOrder.printDescriptionOnInvoice ● Boolean scalar
printDescriptionOnInvoice > Indicates whether to print the description on the invoice.
SalesOrder.printNoteOnExternalDocuments ● Boolean scalar
printNoteOnExternalDocuments > Indicates whether to print the note on external sales documents.
SalesOrder.printNoteOnInternalDocuments ● Boolean scalar
printNoteOnInternalDocuments > Indicates whether to print the line note on internal sales documents.
SalesOrder.customerId ● Int! non-null scalar
customerId > The unique identifier of the customer.
SalesOrder.soBillingContactId ● Int scalar
soBillingContactId > The unique identifier of the billing contact.
SalesOrder.templateStatus ● String scalar
templateStatus > The status of the template.
SalesOrder.soBillingAddressOverrideAddress ● Boolean! non-null scalar
soBillingAddressOverrideAddress > Indicates whether the billing address is overridden.
SalesOrder.soBillingAddressId ● Int scalar
soBillingAddressId > The unique identifier of the billing address.
SalesOrder.soBillingAddressLine1 ● String scalar
soBillingAddressLine1 > The first line of the billing address.
SalesOrder.soBillingAddressLine2 ● String scalar
soBillingAddressLine2 > The second line of the billing address.
SalesOrder.soBillingAddressLine3 ● String scalar
soBillingAddressLine3 > The third line of the billing address.
SalesOrder.soBillingAddressPostalCode ● String scalar
soBillingAddressPostalCode > The postal code of the billing address.
SalesOrder.soBillingAddressCity ● String scalar
soBillingAddressCity > The city of the billing address.
SalesOrder.soBillingAddressCountryId ● String scalar
soBillingAddressCountryId > The country identifier of the billing address.
SalesOrder.soBillingAddressCountyId ● String scalar
soBillingAddressCountyId > The county/state identifier of the billing address.
SalesOrder.branchId ● Int scalar
branchId > The unique identifier of the branch.
SalesOrder.customerVatZoneId ● String scalar
customerVatZoneId > The unique identifier of the customer VAT zone.
SalesOrder.invoiceSeparately ● Boolean! non-null scalar
invoiceSeparately > Indicates that this document is to be invoiced separately.
SalesOrder.invoiceNbr ● String scalar
invoiceNbr > The invoice number of the invoice generated for this order.
SalesOrder.invoiceDate ● DateTime scalar
invoiceDate > The date of the invoice generated for the order.
SalesOrder.creditTermsId ● String scalar
creditTermsId > The unique identifier of the credit terms.
SalesOrder.dueDate ● DateTime scalar
dueDate > The due date of the invoice according to the credit terms.
SalesOrder.cashDiscountDate ● DateTime scalar
cashDiscountDate > The date when the cash discount is available for the invoice.
SalesOrder.postPeriod ● String scalar
postPeriod > The period to post the transactions generated by the invoice. Format MMYYYY.
SalesOrder.salesPersonId ● Int scalar
salesPersonId > The unique identifier of the salesperson.
SalesOrder.ownerId ● UUID scalar
ownerId > The unique identifier of the owner.
SalesOrder.origOrderType ● String scalar
origOrderType > The type of the original order.
SalesOrder.origOrderNbr ● String scalar
origOrderNbr > The order number of the original order.
SalesOrder.soShippingContactId ● Int scalar
soShippingContactId > The unique identifier of the shipping contact.
SalesOrder.soShippingContactName ● String scalar
soShippingContactName > The name from the sales order's shipping-contact snapshot.
SalesOrder.soShippingAddressOverrideAddress ● Boolean! non-null scalar
soShippingAddressOverrideAddress > Indicates whether the shipping address is overridden.
SalesOrder.soShippingAddressId ● Int scalar
soShippingAddressId > The unique identifier of the shipping address.
SalesOrder.soShippingAddressLine1 ● String scalar
soShippingAddressLine1 > The first line of the shipping address.
SalesOrder.soShippingAddressLine2 ● String scalar
soShippingAddressLine2 > The second line of the shipping address.
SalesOrder.soShippingAddressLine3 ● String scalar
soShippingAddressLine3 > The third line of the shipping address.
SalesOrder.soShippingAddressPostalCode ● String scalar
soShippingAddressPostalCode > The postal code of the shipping address.
SalesOrder.soShippingAddressCity ● String scalar
soShippingAddressCity > The city of the shipping address.
SalesOrder.soShippingAddressCountryId ● String scalar
soShippingAddressCountryId > The country identifier of the shipping address.
SalesOrder.soShippingAddressCountyId ● String scalar
soShippingAddressCountyId > The county/state identifier of the shipping address.
SalesOrder.scheduledShipmentDate ● DateTime scalar
scheduledShipmentDate > The date when the ordered goods are scheduled to be shipped.
SalesOrder.shipSeparately ● Boolean! non-null scalar
shipSeparately > Indicates that the goods for the customer should be shipped separately for each sales order.
SalesOrder.shipComplete ● String! non-null scalar
shipComplete > An option that controls whether incomplete and partial shipments for the order are allowed.
SalesOrder.cancelBy ● DateTime scalar
cancelBy > The date when the order should be cancelled if the Back order allowed option has been selected.
SalesOrder.canceled ● Boolean scalar
canceled > Indicates that the order has been cancelled.
SalesOrder.preferredWarehouseId ● Int scalar
preferredWarehouseId > The unique identifier of the preferred warehouse.
SalesOrder.shipViaCarrierId ● String scalar
shipViaCarrierId > The unique identifier of the carrier for shipping.
SalesOrder.fobPointId ● String scalar
fobPointId > The unique identifier of the FOB point.
SalesOrder.fobPointDescription ● String scalar
fobPointDescription > The description of the FOB point.
SalesOrder.priority ● Short! non-null scalar
priority > The level of priority for processing order of this customer.
SalesOrder.shippingTermsId ● String scalar
shippingTermsId > The unique identifier of the shipping terms.
SalesOrder.shippingTermsDescription ● String scalar
shippingTermsDescription > The description of the shipping terms.
SalesOrder.shippingZoneId ● String scalar
shippingZoneId > The unique identifier of the shipping zone.
SalesOrder.shippingZoneDescription ● String scalar
shippingZoneDescription > The description of the shipping zone.
SalesOrder.residentialDelivery ● Boolean! non-null scalar
residentialDelivery > Indicates that the shipment should be delivered to a residential area.
SalesOrder.saturdayDelivery ● Boolean! non-null scalar
saturdayDelivery > Indicates that the order may be delivered on Saturday.
SalesOrder.insurance ● Boolean! non-null scalar
insurance > Indicates that insurance is required for this order.
SalesOrder.transactionTypeId ● Int scalar
transactionTypeId > The unique identifier of the intrastat transaction type.
SalesOrder.transactionTypeDescription ● String scalar
transactionTypeDescription > The description of the intrastat transaction type.
SalesOrder.status ● String scalar
status > The status of the document.
SalesOrder.hold ● Boolean! non-null scalar
hold > Indicates that the document is on hold and should not be processed further.
SalesOrder.date ● DateTime! non-null scalar
date > The date of the document.
SalesOrder.requestOn ● DateTime scalar
requestOn > The date when the customer wants to receive the goods.
SalesOrder.customerOrder ● String scalar
customerOrder > The reference number of the original customer document that the sales order is based on.
SalesOrder.customerRefNbr ● String scalar
customerRefNbr > The reference number of the sales order in a third-party application.
SalesOrder.contactId ● Int scalar
contactId > The contact person of the customer.
SalesOrder.locationId ● Int scalar
locationId > The unique identifier of the location.
SalesOrder.currency ● String scalar
currency > The currency of the document.
SalesOrder.description ● String scalar
description > A brief description of the document.
SalesOrder.orderTotal ● Decimal! non-null scalar
orderTotal > The total amount of the document.
SalesOrder.vatTaxableTotal ● Decimal! non-null scalar
vatTaxableTotal > The document total that is subject to VAT.
SalesOrder.vatExemptTotal ● Decimal! non-null scalar
vatExemptTotal > The document total that is exempt from VAT.
SalesOrder.taxTotal ● Decimal! non-null scalar
taxTotal > The total amount of tax paid on the document.
SalesOrder.note ● String scalar
note > User-defined text connected to the order.
SalesOrder.lastModifiedDateTime ● DateTime! non-null scalar
lastModifiedDateTime > The last modified date and time of the sales order.
SalesOrder.exchangeRate ● Decimal! non-null scalar
exchangeRate > The exchange rate used for the document.
SalesOrder.orderTotalInBaseCurrency ● Decimal! non-null scalar
orderTotalInBaseCurrency > The total amount of the document in base currency.
SalesOrder.locationCountryId ● String scalar
locationCountryId > The country identifier of the location.
SalesOrder.orderQty ● Decimal! non-null scalar
orderQty > The total quantity of items in the sales order.
SalesOrder.deletedDatabaseRecord ● Boolean! non-null scalar
deletedDatabaseRecord > Indicates whether this record has been marked as deleted in the database.
SalesOrder.companyId ● Int! non-null scalar
companyId > (PK) The unique identifier of the company.
SalesOrder.id ● String! non-null scalar
id > The unique identifier of the document in DataMart.
SalesOrder.createdInDataMartDateTime ● DateTime! non-null scalar
createdInDataMartDateTime > The UTC DateTime when this document has been added to DataMart.
SalesOrder.updatedInDataMartDateTime ● DateTime! non-null scalar
updatedInDataMartDateTime > The UTC DateTime when this document has been updated in DataMart.
Returned By
salesOrders query