Skip to main content

SOLine

SOLines. Represents a line item in a sales order.

type SOLine {
orderType: String!
orderNbr: String!
orderDate: DateTime
lineNbr: Int!
sortOrder: Int
branchId: Int!
customerId: Int
behavior: String!
operation: String!
inventoryId: Int
itemClassId: Int
itemStatus: String
siteId: Int
lotSerialNbr: String
expireDate: DateTime @deprecated
expirationDate: DateTime
uom: String
orderQty: Decimal! @deprecated
quantity: Decimal!
shippedQty: Decimal! @deprecated
qtyOnShipments: Decimal!
curyUnitPrice: Decimal! @deprecated
unitPriceInBaseCurrency: Decimal!
unitPrice: Decimal!
unitCost: Decimal
curyUnitCost: Decimal!
taxCategoryId: String
subaccountId: Int
alternateId: String
tranDesc: String @deprecated
lineDescription: String
manualDisc: Boolean @deprecated
manualDiscount: Boolean
discPct: Decimal! @deprecated
discountPercent: Decimal!
discAmt: Decimal! @deprecated
discountAmount: Decimal!
taskId: Int
reasonCode: String
salesPersonId: Int
commissionable: Boolean!
invtMult: Short!
shipComplete: String
completeQtyMin: Decimal! @deprecated
undershipThreshold: Decimal!
completeQtyMax: Decimal! @deprecated
overshipThreshold: Decimal!
openQty: Decimal!
curyLineAmt: Decimal
lineAmt: Decimal
completed: Boolean
curyUnbilledAmt: Decimal
shipDate: DateTime @deprecated
shipOn: DateTime
requestDate: DateTime @deprecated
requestOn: DateTime
discountId: String @deprecated
discountCode: String
invoiceNbr: String
isFree: Boolean @deprecated
freeItem: Boolean
poCreate: Boolean! @deprecated
markForPO: Boolean!
poSource: String
isRUTROTDeductible: Boolean!
noteId: UUID @deprecated
note: String
externalLink: String
discUnitPrice: Decimal
extPrice: Decimal
unbilledAmount: Decimal!
attachments: [Attachment!]
baseUnitName: String
quantityInBaseUnit: Decimal
deletedDatabaseRecord: Boolean!
lastModifiedDateTime: DateTime!
companyId: Int!
id: String!
createdInDataMartDateTime: DateTime!
updatedInDataMartDateTime: DateTime!
}

Fields​

SOLine.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.

SOLine.orderNbr ● String! non-null scalar​

orderNbr > (PK) The reference number of the document.

SOLine.orderDate ● DateTime scalar​

orderDate > The date of the document.

SOLine.lineNbr ● Int! non-null scalar​

lineNbr > (PK) The line number of the document.

SOLine.sortOrder ● Int scalar​

sortOrder > The sort order of the document line. The system regenerates this number automatically when lines are reordered.

SOLine.branchId ● Int! non-null scalar​

branchId > The unique identifier of the branch.

SOLine.customerId ● Int scalar​

customerId > The unique identifier of the customer on the parent sales order. Null when ERP has no customer on the line.

SOLine.behavior ● String! non-null scalar​

behavior > The automation behaviour used for the template. An automation behaviour is a set of automation steps. Values can be Sales order, Invoice, Quote, Credit note, or RMA order.

SOLine.operation ● String! non-null scalar​

operation > The operation to be performed in the workspace to fulfil the order. This information is collected from the system and not visible on the sales order line.

SOLine.inventoryId ● Int scalar​

inventoryId > The unique identifier of the Inventory item.

SOLine.itemClassId ● Int scalar​

itemClassId > Id of the Item Class assigned to the Inventory item.

SOLine.itemStatus ● String scalar​

itemStatus > Status of the Inventory item. [Active, No sales, No purchases, No request, Inactive, Marked for deletion].

SOLine.siteId ● Int scalar​

siteId > The unique identifier of the Warehouse.

SOLine.lotSerialNbr ● String scalar​

lotSerialNbr > The lot or serial number of the item for returns.

SOLine.expirationDate ● DateTime scalar​

expirationDate > The expiration date for the item with the specified lot number.

SOLine.uom ● String scalar​

uom > The unit of measure (UoM) used for the item with this item Id.

SOLine.quantity ● Decimal! non-null scalar​

quantity > The quantity of the item sold, measured in the line's unit of measure (uom).

SOLine.qtyOnShipments ● Decimal! non-null scalar​

qtyOnShipments > A read-only column that displays the quantity of the stock item being prepared for shipment and already shipped for this order.

SOLine.unitPriceInBaseCurrency ● Decimal! non-null scalar​

unitPriceInBaseCurrency > The unit price in the base currency of the company.

SOLine.unitPrice ● Decimal! non-null scalar​

unitPrice > The unit price in the currency of the sales order.

SOLine.unitCost ● Decimal scalar​

unitCost > The cost of the unit on the sales order.

SOLine.curyUnitCost ● Decimal! non-null scalar​

curyUnitCost > The cost of the unit in currency.

SOLine.taxCategoryId ● String scalar​

taxCategoryId > The VAT category of the goods mentioned in the salesOrderLine.

SOLine.subaccountId ● Int scalar​

subaccountId > The unique identifier of the subaccount.

SOLine.alternateId ● String scalar​

alternateId > The alternate Id for the item, such as the item Id used by the customer.

SOLine.lineDescription ● String scalar​

lineDescription > Line description > The description of the unit.

SOLine.manualDiscount ● Boolean scalar​

manualDiscount > Indicates whether the discount has been applied manually.

SOLine.discountPercent ● Decimal! non-null scalar​

discountPercent > The percent of the line-level discount that has been applied manually or automatically to this line item (if the item is not a free item).

SOLine.discountAmount ● Decimal! non-null scalar​

discountAmount > The amount of the line-level discount that has been applied manually or automatically to this line item (if the item is not a free item).

SOLine.taskId ● Int scalar​

taskId > The particular task of the project with which this document is associated.

SOLine.reasonCode ● String scalar​

reasonCode > The reason code to be used for creation or cancellation of the order, if applicable.

SOLine.salesPersonId ● Int scalar​

salesPersonId > The salesperson associated with the sale of the line item.

SOLine.commissionable ● Boolean! non-null scalar​

commissionable > Indicates whether this line is subject to sales commission.

SOLine.invtMult ● Short! non-null scalar​

invtMult > The multiplier for the quantity.

SOLine.shipComplete ● String scalar​

shipComplete > Shipping rule > An option that controls whether incomplete and partial shipments for the order are allowed. [Values: Ship complete, Back order allowed, Cancel remainder].

SOLine.undershipThreshold ● Decimal! non-null scalar​

undershipThreshold > Undership threshold (%) > The minimal percentage of goods shipped (with respect to the ordered quantity) to consider the order shipped completely.

SOLine.overshipThreshold ● Decimal! non-null scalar​

overshipThreshold > Overship threshold (%) > The maximum percentage of goods shipped (with respect to the ordered quantity) allowed by the customer.

SOLine.openQty ● Decimal! non-null scalar​

openQty > The quantity of the item to be shipped; that is, the total quantity minus the quantity shipped according to closed shipment documents.

SOLine.curyLineAmt ● Decimal scalar​

curyLineAmt > Extended price in currency which is the unit price multiplied by the quantity.

SOLine.lineAmt ● Decimal scalar​

lineAmt > Extended Price which is the unit price multiplied by the quantity.

SOLine.completed ● Boolean scalar​

completed > Indicates whether this line is marked as completed.

SOLine.curyUnbilledAmt ● Decimal scalar​

curyUnbilledAmt > Amount in currency not yet invoiced > The amount of cancelled shipments and cancelled remainders.

SOLine.shipOn ● DateTime scalar​

shipOn > The date when the item is to be shipped.

SOLine.requestOn ● DateTime scalar​

requestOn > The date when the customer wants to receive the goods. Defaults to the current business date.

SOLine.discountCode ● String scalar​

discountCode > The code of the discount that has been applied to this line.

SOLine.invoiceNbr ● String scalar​

invoiceNbr > The invoice number of the invoice generated for this order.

SOLine.freeItem ● Boolean scalar​

freeItem > Indicates whether the stock item specified in the row is a free item.

SOLine.markForPO ● Boolean! non-null scalar​

markForPO > Indicates whether the order line is marked for purchasing (if it has not been shipped completely).

SOLine.poSource ● String scalar​

poSource > Purchase order source > The purchase order source to be used to fulfill this line, which can be one of the following options: Purchase to order, Drop-shipment.

SOLine.isRUTROTDeductible ● Boolean! non-null scalar​

isRUTROTDeductible > Indicates whether the line or item is included in the RUTROT calculations.

SOLine.note ● String scalar​

note > The user-defined note text connected to the order.

externalLink > A user-defined external reference. Only editable while the sales order status is Open; becomes read-only after association with a Shipment or Invoice.

SOLine.discUnitPrice ● Decimal scalar​

discUnitPrice > The unit price, which has been recalculated after the application of discounts.

SOLine.extPrice ● Decimal scalar​

extPrice > The extended price in currency.

SOLine.unbilledAmount ● Decimal! non-null scalar​

unbilledAmount > Amount not yet invoiced > The amount of cancelled shipments and cancelled remainders.

SOLine.attachments ● [Attachment!] list object​

attachments > The data containing information about the document attachments.

SOLine.baseUnitName ● String scalar​

baseUnitName > The unit of measure (UoM) used for the item with this item Id.

SOLine.quantityInBaseUnit ● Decimal scalar​

quantityInBaseUnit > The quantity of the item sold, converted to the item's base unit of measure (baseUnitName), as stored by ERP when the line was saved. Null when ERP found no conversion.

SOLine.deletedDatabaseRecord ● Boolean! non-null scalar​

deletedDatabaseRecord > Indicates whether this record has been marked as deleted in the database.

SOLine.lastModifiedDateTime ● DateTime! non-null scalar​

lastModifiedDateTime > The last modified date and time of the document line.

SOLine.companyId ● Int! non-null scalar​

companyId > (PK) The unique identifier of the company.

SOLine.id ● String! non-null scalar​

id > The unique identifier of the document in DataMart.

SOLine.createdInDataMartDateTime ● DateTime! non-null scalar​

createdInDataMartDateTime > The UTC DateTime when this document has been added to DataMart.

SOLine.updatedInDataMartDateTime ● DateTime! non-null scalar​

updatedInDataMartDateTime > The UTC DateTime when this document has been updated in DataMart.

Show deprecatedHide deprecated

SOLine.expireDate ● DateTime deprecated scalar​

DEPRECATED

The value for this field is available in ExpirationDate. This property will be removed in the future.

expireDate > The expiration date for the item with the specified lot number.

SOLine.orderQty ● Decimal! deprecated non-null scalar​

DEPRECATED

The value for this field is available in Quantity. This property will be removed in the future.

orderQty > The quantity of the item sold, measured in the UoM.

SOLine.shippedQty ● Decimal! deprecated non-null scalar​

DEPRECATED

The value for this field is available in QtyOnShipments. This property will be removed in the future.

shippedQty > A read-only column that displays the quantity of the stock item being prepared for shipment and already shipped for this order.

SOLine.curyUnitPrice ● Decimal! deprecated non-null scalar​

DEPRECATED

The value for this field is available in UnitPrice. This property will be removed in the future.

curyUnitPrice > The unit price in the currency of the sales order.

SOLine.tranDesc ● String deprecated scalar​

DEPRECATED

The value for this field is available in LineDescription. This property will be removed in the future.

tranDesc > Line description > The description of the unit.

SOLine.manualDisc ● Boolean deprecated scalar​

DEPRECATED

The value for this field is available in ManualDiscount. This property will be removed in the future.

manualDisc > Indicates whether the discount has been applied manually.

SOLine.discPct ● Decimal! deprecated non-null scalar​

DEPRECATED

The value for this field is available in DiscountPercent. This property will be removed in the future.

discPct > The percent of the line-level discount that has been applied manually or automatically to this line item (if the item is not a free item).

SOLine.discAmt ● Decimal! deprecated non-null scalar​

DEPRECATED

The value for this field is available in DiscountAmount. This property will be removed in the future.

discAmt > The amount of the line-level discount that has been applied manually or automatically to this line item (if the item is not a free item).

SOLine.completeQtyMin ● Decimal! deprecated non-null scalar​

DEPRECATED

The value for this field is available in UndershipThreshold. This property will be removed in the future.

completeQtyMin > Undership threshold (%) > The minimal percentage of goods shipped (with respect to the ordered quantity) to consider the order shipped completely.

SOLine.completeQtyMax ● Decimal! deprecated non-null scalar​

DEPRECATED

The value for this field is available in OvershipThreshold. This property will be removed in the future.

completeQtyMax > Overship threshold (%) > The maximum percentage of goods shipped (with respect to the ordered quantity) allowed by the customer.

SOLine.shipDate ● DateTime deprecated scalar​

DEPRECATED

The value for this field is available in ShipOn. This property will be removed in the future.

shipDate > The date when the item is to be shipped.

SOLine.requestDate ● DateTime deprecated scalar​

DEPRECATED

The value for this field is available in RequestOn. This property will be removed in the future.

requestDate > The date when the customer wants to receive the goods. Defaults to the current business date.

SOLine.discountId ● String deprecated scalar​

DEPRECATED

The value for this field is available in DiscountCode. This property will be removed in the future.

discountId > The code of the discount that has been applied to this line.

SOLine.isFree ● Boolean deprecated scalar​

DEPRECATED

The value for this field is available in FreeItem. This property will be removed in the future.

isFree > Indicates whether the stock item specified in the row is a free item.

SOLine.poCreate ● Boolean! deprecated non-null scalar​

DEPRECATED

The value for this field is available in MarkForPO. This property will be removed in the future.

poCreate > Indicates whether the order line is marked for purchasing (if it has not been shipped completely).

SOLine.noteId ● UUID deprecated scalar​

DEPRECATED

The value for this field is available in Note. This property will be removed in the future.

noteId > The internal identifier for user-defined notes connected to the order.

Returned By​

salesOrderLineById query ● salesOrderLines query