Item

Return, update, create and delete item type sale orders

Date Released: Jun 2014 Date Updated: Jan 2022
URLSupports
/{cf_uri}/Sale/Order/Item GET |  PUT |  POST |  DELETE
Please note: While accessibility via the API is available to both AccountRight and new Essentials files. Not all features will be displayed in Product for new Essentials or the AccountRight Browser.

The elements list below details information for Item. To view the descriptions for the elements you can either hover any attribute to reveal details or click here to show all details inline.

Items shown with are required when posting or puting data
Items shown with are read-only elements

Attribute Details

  • UIDGuid (36)
  • Unique guid identifier created for an item sale order.
    ONLY required for updating an existing item sale order.
    NOT required when creating a new item sale order.
  • Number String (13)
  • Order Sale number, if left blank on POST/PUT will auto increment based on last recorded #
  • DateDateTime
  • Transaction date entry, format YYYY-MM-DD HH:MM:SS { 'Date': '2014-06-21 00:00:00' }
  • ShipToAddressString (255)
  • ShipTo address of the sale order.
  • CustomerPurchaseOrderNumberString (255)
  • Customer PO number.
  • Customer
  • The following set of information pulls through details for the Customer contact
    • UIDGuid (36)
    • Foreign Key: Unique guid identifier belonging to the customer assigned to the item sale.
    • NameString (50)
    • Name of the customer.
    • DisplayIDString (15)
    • Customer contact Card ID, can also be used as a unique customer contact identifier.
    • URIString
    • Uniform resource identifier associated with the customer object.
  • Terms
  • The following set of information pulls through customer payment terms.

    Please note: When posting a new sale invoice, if you do not set the terms, default payment terms from the customer contact card will be substituted instead.
    • PaymentIsDueString
    • Default Terms of Payment definitions:
      CashOnDelivery
      PrePaid
      InAGivenNumberOfDays
      OnADayOfTheMonth
      NumberOfDaysAfterEOM
      DayOfMonthAfterEOM
    • DiscountDate Integer
    • If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which the customer must pay to receive discounts.

      If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which the payment must be made to receive discounts.
    • BalanceDueDate Integer
    • If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which the customer has to pay invoices.

      If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which the payment must be made to pay invoices.
    • DiscountForEarlyPayment Double (99.99%)
    • % discount for early payment.
    • MonthlyChargeForLatePayment Double (99.99%)
    • % monthly charge for late payment.
    • DiscountExpiryDateDateTime
    • Date in which payment must be paid in full in order to receive discount, format YYYY-MM-DD HH:MM:SS { 'Date': '2014-06-14 00:00:00' }
    • DiscountDecimal (13.2)
    • Discount amount that will apply if payment is made in full by the discount date.
    • DiscountForeignDecimal (13.2)
    • Discount amount in foreign currency that will apply if payment is made in full by the discount date.
    • DueDateDateTime
    • Date in which payment is due, format YYYY-MM-DD HH:MM:SS { 'Date': '2014-06-30 00:00:00' }
    • FinanceChargeDecimal (13.2)
    • Late payment fee to be charged if payment is not made in full by the due date.
    • FinanceChargeForeignDecimal (13.2)
    • Late payment fee to be charged in foreign currency if payment is not made in full by the due date.
  • IsTaxInclusiveBoolean
  • True indicates the transaction is tax inclusive with both UnitPrice and Total values to be keyed in tax-inclusive.

    False indicates the transaction is not tax inclusive with both UnitPrice and Total values to be keyed in tax-exclusive.
  • Lines []
  • An array of item line order information
    • RowID Integer
    • Sequence of the entry within the item sale order set.
      REQUIRED only when passing the RowVersion for updating an existing item sale line.
    • TypeString
    • Line type, can consist of the following:
      Transaction - All fields detailed in Lines array are consumable.
      Header - Only allows you to POST to Description element.
      Subtotal - Calculated value that is read-only.
    • DescriptionString (1000)
    • Description text for the sale line.
    • ShipQuantityDecimal (13.6)
    • The quantity of goods shipped.
    • UnitPriceDecimal (13.6)
    • Mandatory for a Local currency record : Unit price assigned to the item.
    • UnitPriceForeignDecimal (13.6)
    • Mandatory for a Foreign currency record : Unit price assigned to the item in foreign currency.
    • DiscountPercentDouble (99.99%)
    • Discount rate applicable to the line of the sale order.
    • TotalDecimal (13.2)
    • Mandatory for a Local currency record : Total amount for the line item only.
    • TotalForeignDecimal (13.2)
    • Total amount om foreign currency for the line item only.
    • Item
    • The following set of information pulls through details for an Item
      • UIDGuid (36)
      • Foreign Key: Unique identifier for item in the form of a guid.
      • NumberString (30)
      • Number assigned to the item.
      • NameString (30)
      • Name assigned to the item.
      • URIString
      • Uniform resource identifier associated with the item object.
    • Job
    • The following set of information pulls through the details for a job
      • UID GUID (36)
      • Foreign Key: Unique guid identifier belonging to the job for the line of the item sale.
      • Number String (30)
      • Number assigned to the job
      • Name String (30)
      • Name assigned to the job
      • URI String
      • Uniform resource identifier associated with the job object
    • TaxCode
    • The following set of information pulls through the details for the Tax Code
      • UID GUID (36)
      • Foreign Key: Unique tax code identifier in the form of a guid
      • Code String (3)
      • 3 digit code assigned to the tax code.
      • URI String
      • Uniform resource identifier associated with the tax code object.
    • Location
    • The following set of information pulls through details for the item associated location./li>
      • UIDGuid (36)
      • Foreign Key: Unique identifier for location in the form of a guid.
      • IdentifierString (10)
      • Identifier assigned to the location.
      • NameString (30)
      • Name assigned to the location.
      • URIString
      • Uniform resource identifier associated with the location object.
    • RowVersion String
    • ONLY required on PUT(Update) for updating an existing item sale line.
      NOT required when creating a new item sale order.
  • SubtotalDecimal (13.2)
  • If IsTaxInclusive = false then sum of all tax exclusive line amounts.
    If IsTaxInclusive = true then sum of all tax inclusive line amounts.
  • SubtotalForeignDecimal (13.2)
  • If IsTaxInclusive = false then sum of all tax exclusive line amounts.
    If IsTaxInclusive = true then sum of all tax inclusive line amounts.
  • FreightDecimal (13.2)
  • Tax inclusive freight amount applicable to the sale order.
  • FreightForeignDecimal (13.2)
  • Tax inclusive freight amount applicable to the sale order in foreign currency.
  • FreightTaxCode
  • The following set of information pulls through the details for freight Tax Codes
    • UID GUID (36)
    • Foreign Key: Unique freight tax code identifier in the form of a guid
    • Code String (3)
    • 3 digit code assigned to the freight tax code.
    • URI String
    • Uniform resource identifier associated with the freight tax code object.
  • TotalTaxDecimal (13.2)
  • Total of all tax amounts applicable to the sale order.
  • TotalAmountDecimal (13.2)
  • Total amount of the sale order.
  • TotalAmountForeignDecimal (13.2)
  • Total amount of the sale order in foreign currency.
  • Category
  • The following outlines category information for the sale item order.
    • UID GUID (36)
    • Foreign Key: Unique guid identifier belonging to the category assigned to the sale order
    • Name String (30)
    • Name of the category
    • DisplayID String (15)
    • Display id for the category
    • URI String
    • Uniform resource identifier associated with the category object
  • Salesperson
  • The following set of information pulls through details for the an employee contact.
    • UIDGuid (36)
    • Foreign Key: Unique employee contact identifier in the form of a guid.
    • NameString (30)
    • Selected employee contact name.
    • DisplayIDString (15)
    • Employee contact Card ID, can also be used as a unique employee contact identifier.
    • URIString
    • Uniform resource identifier associated with the employee contact object.
  • CommentString (2000)
  • Sale order comment.
  • ShippingMethodString (20)
  • Shipping method text.
  • JournalMemoString (255)
  • Journal memo text describing the sale.
  • PromisedDateDateTime
  • Transaction promised date, format YYYY-MM-DD HH:MM:SS { 'PromisedDate': '2014-06-12 00:00:00' }
  • DeliveryStatusString (20)
  • Order delivery status assigned:
    Print = ToBePrinted
    Email = ToBeEmailed
    PrintAndEmail = ToBePrintedAndEmailed
    Nothing = AlreadyPrintedOrSent
  • ReferralSourceString (20)
  • Referral Source selected on the sale order.
  • AppliedToDateDecimal (13.2)
  • Payment amount already applied to sale order.
  • AppliedToDateForeignDecimal (13.2)
  • Payment amount already applied to sale order in foreign currency.
  • BalanceDueAmountDecimal (13.2)
  • Amount still payable on the sale order.
  • BalanceDueAmountForeignDecimal (13.2)
  • Amount still payable on the sale order in foreign currency.
  • StatusString
  • Order status can consist of the following:

    Open - If an order is paid in full, partially paid or has a negative amount, the status will always be set to Open

    ConvertedToInvoice - This status will only show if an Order has been converted to an Invoice. Please note: once an order has been converted to an invoice, you can no longer edit or delete the order, only retrieve it.
  • LastPaymentDateDateTime
  • The most recent order payment, format YYYY-MM-DD HH:MM:SS
  • ForeignCurrency
  • Foreign currency information in the transaction
    • UIDGuid (36)
    • Foreign Key: Unique identifier for the currency in the form of a guid.
    • CodeString (3)
    • The currency code.
    • CurrencyNameString
    • The full name of the currency
    • URIString
    • Uniform resource identifier associated with the currency object.
  • CurrencyExchangeRateDecimal
  • Currency exchange rate in the associated currency object.
  • LastModifiedDateTime
  • DateTime of the last time this resource was modified through a direct action to the object. eg a field was updated.
  • URIString
  • Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
  • RowVersionString
  • Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
    ONLY required for updating an existing item sale order.
    NOT required when creating a new item sale order.


Paging: default page size is set to 400 with a maximum of 1000 results.

Example json GET response

  • {
  • "UID" : "2c81636a-8548-4cb2-a276-af83a186fdca",
  • "Number" : "00000015",
  • "Date" : "2014-05-29T00:00:00",
  • "ShipToAddress" : "A-Z Stationery Supplies 22 Smith Street Carlingford NSW 2056 Australia",
  • "CustomerPurchaseOrderNumber" : null,
  • "Customer" : {
    • "UID" : "d61a6a86-453a-48bf-9402-6eb6b4ea23cf",
    • "Name" : "A-Z Stationery Supplies",
    • "DisplayID" : "CUS000001",
    • "URI" : "{cf_uri}/Contact/Customer/d61a6a86-453a-48bf-9402-6eb6b4ea23cf"
    • },
  • "Terms" : {
    • "PaymentIsDue" : "DayOfMonthAfterEOM",
    • "DiscountDate" : 1,
    • "BalanceDueDate" : 30,
    • "DiscountForEarlyPayment" : 5,
    • "MonthlyChargeForLatePayment" : 8.5,
    • "DiscountExpiryDate" : "2014-06-01T00:00:00",
    • "Discount" : 16.99,
    • "DiscountForeign" : null,
    • "DueDate" : "2014-06-30T00:00:00",
    • "FinanceCharge" : 0,
    • "FinanceChargeForeign" : null,
    • },
  • "IsTaxInclusive" : true,
  • "Lines" : [
    • {
  • "RowID" : 3,
  • "Type" : "Transaction",
  • "Description" : "Cooler Filter Large",
  • "ShipQuantity" : 5,
  • "UnitPrice" : 67.95,
  • "UnitPriceForeign" : null,
  • "DiscountPercent" : 0,
  • "Total" : 339.75,
  • "TotalForeign" : null,
  • "Item" : {
    • "UID" : "d5ab0fd1-3bf4-4230-bbaf-90b26ea9afda",
    • "Number" : "120",
    • "Name" : "Cooler Filter Large",
    • "URI" : "{cf_uri}/Inventory/Item/d5ab0fd1-3bf4-4230-bbaf-90b26ea9afda"
    • },
  • "Job" : null,
  • "TaxCode" : {
    • "UID" : "38a37ae8-565c-46f8-ad4a-2a87069607f8",
    • "Code" : "GST",
    • "URI" : "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8"
    • },
  • "Location" : {
    • "UID" : "04ad68a3-91f5-4739-8b83-13f86ecd2e33",
    • "Identifier" : "Location1",
    • "Name" : "Primary Location",
    • "URI" : "{cf_uri}"
    • },
  • "RowVersion" : "-8814670370670903296"
  • }
  • ],
  • "Subtotal" : 339.75,
  • "SubtotalForeign" : null,
  • "Freight" : 0,
  • "FreightForeign" : null,
  • "FreightTaxCode" : {
    • "UID" : "38a37ae8-565c-46f8-ad4a-2a87069607f8",
    • "Code" : "GST",
    • "URI" : "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8"
    • },
  • "TotalTax" : 30.89,
  • "TotalTaxForeign" : null,
  • "TotalAmount" : 339.75,
  • "TotalAmountForeign" : null,
  • "Category" : {
    • "UID" : "b211a2a3-0be9-477c-940e-1c8bac139cf1",
    • "Name" : "Melbourne",
    • "DisplayID" : "CAT101",
    • "URI" : "{cf_uri}/GeneralLedger/Category/b211a2a3-0be9-477c-940e-1c8bac139cf1"
    • },
  • "Salesperson" : null,
  • "Comment" : "We appreciate your business.",
  • "ShippingMethod" : "Australia Post",
  • "JournalMemo" : "Sale; A-Z Stationery Supplies",
  • "PromisedDate" : null,
  • "DeliveryStatus" : "Print",
  • "ReferralSource" : "Brochure",
  • "AppliedToDate" : 0,
  • "AppliedToDateForeign" : null,
  • "BalanceDueAmount" : 339.75,
  • "BalanceDueAmountForeign" : null,
  • "Status" : "Open",
  • "LastPaymentDate" : null,
  • "ForeignCurrency" : null,
  • "CurrencyExchangeRate" : null,
  • "LastModified" : "2019-05-01T00:47:43.757",
  • "URI" : "{cf_uri}/Sale/Order/Item/2c81636a-8548-4cb2-a276-af83a186fdca",
  • "RowVersion" : "-8958785558746759168"
  • }
Hypermedia in the MYOB Business API

The {cf_uri} is provided by the Company File endpoint.

Read more about Hypermedia in the MYOB Business API in our best practice guide.