Order - accountsIQ/API-Wiki GitHub Wiki

Presentation of the Order data structure. Orders can be created for customers and suppliers, then be delivered and invoiced.

Order

Order members

Name Type Description Constraints
AccountAddress1 String Get/Set the customer/supplier account address 's first line.
  • Cannot be more than 50 characters.
AccountAddress2 String Get/Set the customer/supplier account address 's second line.
  • Cannot be more than 50 characters.
AccountID Int32 Get/Set the unique identifier of the customer/supplier.
  • Cannot be negative or 0.
AccountName String Get/Set the customer/supplier account name. It is duplicated here from the customer/supplier account record as it may have changed since the order was created.
  • Cannot be be null or empty.
  • Cannot be more than 50 characters.
AccountTaxCode String Get/Set the account tax code if the customer/supplier uses a default tax code. This field is used only if the UseAccountTaxCode flag is set.
  • Cannot be more than 50 characters.
ApprovalStatusName String Get the approval status.
AreaID String Get/Set the area unique identifier related to the order.
  • Cannot be more than 50 characters long
AuthorUserName String Get the name of the user who created the order.
AuthorUserID String Get the unique identifier of the user who created the order.
  • Cannot be null
  • Cannot be empty
  • Cannot be more than 8 characters long
City String Get/Set customer/supplier city.
  • Cannot be more than 50 characters
Contact String Get/Set the customer/supplier contact name.
  • Cannot be more than 50 characters
Country String Get/Set the customer/supplier country's name.
  • Cannot be more than 50 characters
County_State String Get/Set the customer/supplier county or state.
  • Cannot be more than 50 characters
OrderDate DateTime Get the order creation date.
  • Must be a valid date
CreationDate DateTime Get the order creation date.
  • Must be a valid date
DeliveryDate DateTime Get/Set the order delivery date.
  • Must be a valid date
CurrencyCode String Get/Set the currency code of the order.
  • Cannot be null
  • Cannot be empty
  • Cannot be more than 50 characters long
DeliveryAddress1 String Get/Set customer/supplier delivery address's first line.
  • Cannot be more than 50 characters long
DeliveryAddress2 String Get/Set customer/supplier delivery address's second line.
  • Cannot be more than 50 characters long
DeliveryAccountName String Get/Set customer/supplier delivery account name. The delivery account name can be different from the account name.
  • Cannot be more than 50 characters long
DeliveryCity String Get/Set the customer/supplier delivery city.
  • Cannot be more than 50 characters long
DeliveryCounty_State String Get/Set customer/supplier delivery county or state.
  • Cannot be more than 50 characters long
DeliveryCountry String Get/Set the customer/supplier delivery country.
  • Cannot be more than 50 characters long
DeliveryPostCode String Get/Set the customer/supplier delivery post code.
  • Cannot be more than 50 characters long
DepartmentID String Get/Set the default department ID.
  • Cannot be null
DiscountRate Decimal Get/Set the default discount rate for the order.
  • Cannot be negative
ExchangeRate Decimal Get/Set the currency exchange rate between the customer/supplier currency and the system base currency for the current order.
  • Cannot be negative or 0
ExternalReference String Get/Set the order external reference.
  • Cannot be more than 50 characters long
ExternalApproverName String Get the name of the approver.
ForCollection Boolean Get/Set a flag indicating whether the order is for collection or not.
    Hold Int16 Get/Set the hold status of the invoice. Unknown List Class
      IsClosed Boolean Get whether the order has been closed or not.
        Ledger LedgerType Get the order ledger type: Sales or Purchases.
          Lines OrderLine[] Get the array of order lines. There is not limit to the amount of lines an order can have.
            Notes String Get/Set some notes on the order.
            • Cannot be more than 250 characters long
            OrderID Int32 Get the Order unique identifier.
            • Cannot be negative or 0.
            OrderNumber String Get/Set the order number. Used only if the customer/supplier does not use auto-numbering for orders.
            • Cannot be null
            • Cannot be empty
            • Cannot be more than 50 characters long
            PaymentMethodID String Get/Set the customer/supplier payment method.
            • Cannot be more than 50 characters long
            Phone String Get/Set the customer/supplier phone number.
            • Mandatory. If not empty, it cannot be more than 50 characters long
            PostCode String Get/Set customer/supplier post code.
            • Cannot be more than 50 characters long
            QuoteID Nullable
            Int 32
            Get the quote unique identifier if the order has been created by promoting a quote.
              QuoteNumber String Get the quote number if the order has been created by promoting a quote.
              • Cannot be more than 50 characters long
              ShipmentViaID String Get/Set the ship via unique identifier.
              • Cannot be more than 50 characters long
              Status OrderStatus Get the order status:

            • Reserved: the order has just been created and has not been delivered yet. The stock quantities have been reserved on the corresponding items.

            • PartiallyDelivered: the order has been partially delivered, some of it is still outstanding though.

            • FullyDelivered: all stock has been delivered

            • Complete: all deliveries have been invoiced

            • Closed: the order was closed before reaching completion date.
              • TransferID Int32 Get the franchisor's Sales Quote ID if the purchase order was transferred as a quote from a franchisee to a franchisor.
                  TransferReference String Get the transfer reference if the purchase order was transferred as a quote from a franchisee to a franchisor.
                    UseAccountTaxCode Boolean Get/Set a flag indicating whether the customer/supplier chooses to use the tax code from itself rather than the ones coming from the stock items. This is only useful for interactive use, on the web service this does not do anything.
                    • Cannot be null

                    See Also

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