OrderLine - accountsIQ/API-Wiki GitHub Wiki

Presentation of the OrderLine data structure. OrderLine belongs to an Order.

OrderLine

OrderLine members

Name Type Description Constraints
StockItemID String Get/Set the stock item used on the order line.
  • Cannot be null
  • Cannot be empty
  • Cannot be more than 50 characters
  • Must be upper case
StockItemDescription String Get/Set the description of the stock item used on the line.
  • Cannot be null
  • Cannot be empty
  • Cannot be more than 500 characters
StockItemPrice Decimal Get/Set the price at which the stock item is being bought or sold on the current line.When the stock item price is recalculated, the actual price, net amount, tax amount and gross amount are recalculated
  • Cannot be negative
ActualPrice Decimal Get the actual price of the item, i.e. the price once discounted.
  • Cannot be negative.
CreationDate DateTime Get the creation date of the line.
  • Must be a valid date.
DeliveredQuantity Decimal Get the quantity that was already delivered from the order line.
  • Cannot be negative.
  • Cannot be less than the invoiced quantity.
DepartmentID String Get/Set the line department identifier.
  • Cannot be empty
  • Cannot be more than 50 characters long
LocationID String Get/Set the location ID of by the stock item to be delivered in or out of. Can be obtain by calling GetStockItem
  • Cannot be null
  • Cannot be empty
  • Cannot be more than 50 characters
SublocationID String Get/Set the sub-location ID of the stock item to be delivered in or out of. Can be obtain by calling GetStockItem
  • Cannot be null
DiscountRate Decimal Get/Set the line discount rate. This is used to calculate the actual price of an item on a line.
  • Cannot be negative
  • Cannot be >= 1
InvoicedQuantity Decimal Get the quantity that was delivered and invoiced from the current order line.
  • Cannot be negative
GLAccountCode String Get/Set the nominal account code used during the line posting to the transaction table.
  • Cannot be null
  • Cannot be empty
  • Cannot be more than 50 characters
OpeningStockGLAccountCode String Get/Set the opening stock GL account code that will be used during the posting of the invoice to the transaction table.
  • Cannot be null
  • Cannot be empty
  • Cannot be more than 50 characters
GrossAmount Decimal Get/Set the gross amount of the order line.
  • Cannot be negative
NetAmount Decimal Get the net amount of the line.
  • Cannot be negative
Notes String Get/Set the notes attached to the order.
  • Cannot be more than 250 characters
Notes2 String Get/Set the notes attached to the order.
  • Cannot be more than 250 characters
OrderID Int32 Get the reference of the order the line belongs to.
    OrderItemID Int32 Get the unique identifier of the order line.
      OrderedQuantity Decimal Get/Set the ordered quantity.
      • Cannot be 0 or negative
      • Cannot be below the delivered quantity
      QuoteItemID Nullable
      Int32
      Get the quote line unique identifier from which the current order line was created from, if the order was created by promoting a quote.
        StockItemCost Decimal Get/Set the stock item cost: used for average costing calculation, cost of sales postings and margin analysis.
        • Cannot be negative
        TaxAmount Decimal Get/Set the tax amount used on the line.
        • Cannot be negative
        TaxCode String Get/Set the tax code used on the order line.
        • Cannot be null
        • Cannot be empty
        • Cannot be more than 50 characters
        TaxRate Decimal Get/Set the tax rate applied on the line.
        • Cannot be negative

        See Also

        ⚠️ **GitHub.com Fallback** ⚠️