Skip to main content

SalesOrder

A confirmed demand from a customer to ship goods, usually converted from a quote. Moves through confirmation, shipment, invoicing and payment.

type SalesOrder {
billingAddress: SalesOrderAddress
branchAddressId: String
branchInactive: Boolean
branchLabel: String
courierPlan: CourierPlan
createdAt: DateTime!
createdBy: String!
creatorName: String!
creditLimitOverride: CreditLimitOverride
currency: String
customFields: JSON
customerEmail: String
customerId: String!
customerMobile: String
customerName: String!
customerPoNumber: String
deletedAt: DateTime
deliveredDate: DateTime
deliveryInstructions: String
deliverySelection: ShipmentCustomerChoice
discountAmount: Float!
exchangeRate: Float
freightQuote: SalesOrderFreightQuote
id: ID!
internalNotes: String
itemCount: Int!
items: [SalesOrderItem!]!
lineReturns: [OrderLineReturns!]!
notes: String
onlinePayment: SalesOrderOnlinePayment
orderDate: DateTime!
orderNumber: String!
organizationId: String!
paymentStatus: PaymentStatus!
paymentSummary: SalesOrderPaymentSummary
paymentTerms: String!
promisedDate: DateTime
purchaseOrders: [LinkedPurchaseOrderRef!]
reference: String
shippedDate: DateTime
shippingAddress: SalesOrderAddress
shippingAmount: Float!
shippingMethod: String
shortCloseReason: String
shortClosedAt: DateTime
shortClosedBy: String
sourceQuoteId: String
sourceQuoteNumber: String
status: SalesOrderStatus!
subtotal: Float!
taxAmount: Float!
taxCalculationMethod: String
totalAmount: Float!
trackingNumber: String
updatedAt: DateTime!
version: Int!
warehouse: Warehouse
warehouseId: String
}

Fields​

SalesOrder.billingAddress ● SalesOrderAddress object​

The billing address on the order.

SalesOrder.branchAddressId ● String scalar​

Branch attribution: the branch Address id this order was placed for. Null on partner-level orders.

SalesOrder.branchInactive ● Boolean scalar​

True when the branch address is soft-deleted, un-flagged, or inactive (EDGE) — the label still renders.

SalesOrder.branchLabel ● String scalar​

Branch display name (the branch Address label), resolved org-scoped. Null when the order has no branch.

SalesOrder.courierPlan ● CourierPlan object​

The courier plan: customer's original courier and price, the active staff change with courier charge, customer share, seller share and reason, and the history. Null unless the caller may ship orders (sales:sales_order:ship).

SalesOrder.createdAt ● DateTime! non-null scalar​

When the record was created.

SalesOrder.createdBy ● String! non-null scalar​

The ID of the user who created the order.

SalesOrder.creatorName ● String! non-null scalar​

The name of the user who created the order.

SalesOrder.creditLimitOverride ● CreditLimitOverride object​

Set when this save or confirmation went over the partner's credit limit and was allowed by the user's override permission, so the screen can warn. Null otherwise, and always null when the document is read later.

SalesOrder.currency ● String scalar​

Currency code of the document's amounts.

SalesOrder.customFields ● JSON scalar​

The organization's own fields on this order, keyed by field key. Only fields the caller may see are returned; null when the values were not loaded.

SalesOrder.customerEmail ● String scalar​

The customer's email address, as stored on the order.

SalesOrder.customerId ● String! non-null scalar​

The ID of the customer who placed the order.

SalesOrder.customerMobile ● String scalar​

The customer's mobile number, as stored on the order.

SalesOrder.customerName ● String! non-null scalar​

The customer's name, as stored on the order.

SalesOrder.customerPoNumber ● String scalar​

Buyer-supplied PO number (portal checkout).

SalesOrder.deletedAt ● DateTime scalar​

When the record was deleted. Null while it is active.

SalesOrder.deliveredDate ● DateTime scalar​

When the order was delivered. Null until delivered.

SalesOrder.deliveryInstructions ● String scalar​

Delivery instructions for the shipment.

SalesOrder.deliverySelection ● ShipmentCustomerChoice object​

The live delivery option recorded on the order (the buyer's checkout choice or the rep's pick): partner, carrier, service, agreed amount and currency. Null when none.

SalesOrder.discountAmount ● Float! non-null scalar​

Total discount amount on the order.

SalesOrder.exchangeRate ● Float scalar​

Exchange rate between the document currency and the organization's base currency, when they differ.

SalesOrder.freightQuote ● SalesOrderFreightQuote object​

Set when the order was too heavy to price delivery live (box packing freight threshold): placed with no delivery charge for staff to quote. Null otherwise.

SalesOrder.id ● ID! non-null scalar​

Unique identifier of the record.

SalesOrder.internalNotes ● String scalar​

Notes for your team only; never shown to the customer.

SalesOrder.itemCount ● Int! non-null scalar​

Number of lines on the order.

SalesOrder.items ● [SalesOrderItem!]! non-null object​

The line items on the order.

SalesOrder.lineReturns ● [OrderLineReturns!]! non-null object​

Per order line: units already on returns made against this order, and units a new return may still take (ordered less returned). Creating a return refuses more.

SalesOrder.notes ● String scalar​

Notes on the document, visible to the customer.

SalesOrder.onlinePayment ● SalesOrderOnlinePayment object​

The online (payment gateway) payment that settled this order. Null for EFT / on-account / COD orders and unpaid ones; only populated on the single-order read.

SalesOrder.orderDate ● DateTime! non-null scalar​

The date the order was placed.

SalesOrder.orderNumber ● String! non-null scalar​

The human-readable sales order number, unique within the organization.

SalesOrder.organizationId ● String! non-null scalar​

The ID of the organization (tenant) that owns the record.

SalesOrder.paymentStatus ● PaymentStatus! non-null enum​

How much of the order has been paid. See PaymentStatus.

SalesOrder.paymentSummary ● SalesOrderPaymentSummary object​

Money received against the order, the balance still to take, the part a second person verified and portal transfers awaiting the seller's acceptance. Null when the order cannot be read.

SalesOrder.paymentTerms ● String! non-null scalar​

The payment terms agreed for the order.

SalesOrder.promisedDate ● DateTime scalar​

The delivery date promised to the customer. Null when none was promised.

SalesOrder.purchaseOrders ● [LinkedPurchaseOrderRef!] list object​

Purchase orders raised to supply this order (reverse-resolved from PurchaseOrder.sourceSalesOrderId). Only populated on the single-order read.

SalesOrder.reference ● String scalar​

Your own reference for the order.

SalesOrder.shippedDate ● DateTime scalar​

When the order was shipped. Null until it ships.

SalesOrder.shippingAddress ● SalesOrderAddress object​

The shipping address on the order.

SalesOrder.shippingAmount ● Float! non-null scalar​

Shipping charge on the order.

SalesOrder.shippingMethod ● String scalar​

The shipping method chosen for the order.

SalesOrder.shortCloseReason ● String scalar​

The reason given when the order was short-closed.

SalesOrder.shortClosedAt ● DateTime scalar​

When the order was short-closed. Null if it was not.

SalesOrder.shortClosedBy ● String scalar​

The ID of the user who short-closed the order.

SalesOrder.sourceQuoteId ● String scalar​

Id of the quote this order was converted from (reverse-resolved from Quote.convertedToSalesOrderId). Null for a directly created order; only populated on the single-order read.

SalesOrder.sourceQuoteNumber ● String scalar​

Number of the quote this order was converted from. Null for a directly created order; only populated on the single-order read.

SalesOrder.status ● SalesOrderStatus! non-null enum​

Where the order is in its lifecycle. See SalesOrderStatus for the values and the allowed transitions.

SalesOrder.subtotal ● Float! non-null scalar​

Subtotal of the order lines, as calculated by the server.

SalesOrder.taxAmount ● Float! non-null scalar​

Total tax on the order.

SalesOrder.taxCalculationMethod ● String scalar​

Whether line prices include tax (INCLUSIVE) or tax is added on top (EXCLUSIVE).

SalesOrder.totalAmount ● Float! non-null scalar​

The order total in the order currency, as calculated and stored by the server.

SalesOrder.trackingNumber ● String scalar​

The carrier tracking number, once shipped.

SalesOrder.updatedAt ● DateTime! non-null scalar​

When the record was last changed.

SalesOrder.version ● Int! non-null scalar​

Optimistic-concurrency counter — pass back as expectedVersion on the next mutation.

SalesOrder.warehouse ● Warehouse object​

The warehouse the order is fulfilled from.

SalesOrder.warehouseId ● String scalar​

The ID of the warehouse the order is fulfilled from.

Returned By​

appCreateSalesOrder mutation ● appUpdateSalesOrderLines mutation ● cancelSalesOrder mutation ● changeOrderCourier mutation ● confirmSalesOrder mutation ● convertQuoteToSalesOrder mutation ● createSalesOrder mutation ● duplicateSalesOrder mutation ● lastSalesOrder query ● markSalesOrderDelivered mutation ● removeSalesOrder mutation ● revertOrderCourier mutation ● salesOrder query ● salesOrders query ● shipSalesOrder mutation ● shortCloseSalesOrder mutation ● updateSalesOrder mutation ● updateSalesOrderStatus mutation

Member Of​

Invoice object ● Payment object ● ProductReturn object ● Quote object ● SalesOrderSummary object