ItemPriceMatrix

Return and update the item price matrix for multiple customer selling prices.

Date Released: Dec 2013 Date Updated: Dec 2020
URLSupports
/{cf_uri}/Inventory/ItemPriceMatrix 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 ItemPriceMatrix. 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 item identifier in the form of a guid.
    ONLY required for updating an existing item.
    NOT required when creating a new item.
  • 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. Note: same as the UID above.
    • NumberString (30)
    • Number assigned to the item.
    • NameString (30)
    • Name assigned to the item.
    • URIString
    • Uniform resource identifier associated with the item object.
  • SellingPrices []
  • An array of selling price information
    • QuantityOverDecimal (12.3)
    • The first QuantityOver must always be 0, for each additional quantity break specify the item quantity.
    • Levels
    • The following set of information pulls through details for each item price level.
      • LevelADecimal (12.6)
      • If QuantityOver = 0 for Level A is greater than the BaseSellingPrice on a PUT, the BaseSellingPrice on the item will be updated to reflect Level A. .
      • LevelBDecimal (12.6)
      • Item price Level B, defaults to items Base Selling Price.
      • LevelCDecimal (12.6)
      • Item price Level C, defaults to items Base Selling Price.
      • LevelDDecimal (12.6)
      • Item price Level D, defaults to items Base Selling Price.
      • LevelEDecimal (12.6)
      • Item price Level E, defaults to items Base Selling Price.
      • LevelFDecimal (12.6)
      • Item price Level F, defaults to items Base Selling Price.
  • 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.


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

Example json GET response

  • {
  • "UID" : "d5ab0fd1-3bf4-4230-bbaf-90b26ea9afda",
  • "Item" : {
    • "UID" : "d5ab0fd1-3bf4-4230-bbaf-90b26ea9afda",
    • "Number" : "680",
    • "Name" : "12 Litres Orange Carbon",
    • "URI" : "{cf_uri}/Inventory/Item/d5ab0fd1-3bf4-4230-bbaf-90b26ea9afda"
    • },
  • "SellingPrices" : [
    • {
  • "QuantityOver" : 0,
  • "Levels" : {
    • "LevelA" : 37.95,
    • "LevelB" : 37.95,
    • "LevelC" : 37.95,
    • "LevelD" : 41.95,
    • "LevelE" : 45.95,
    • "LevelF" : 49.95
    • }
  • },
  • {
  • "QuantityOver" : 10,
  • "Levels" : {
    • "LevelA" : 37.95,
    • "LevelB" : 37.95,
    • "LevelC" : 49.95,
    • "LevelD" : 55.95,
    • "LevelE" : 59.95,
    • "LevelF" : 69.95
    • }
  • }
  • ],
  • "URI" : "{cf_uri}/Inventory/ItemPriceMatrix/d5ab0fd1-3bf4-4230-bbaf-90b26ea9afda",
  • "RowVersion" : "6560055807218548736"
  • }
  • 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.