Build

Return's Build transaction journals

Date Released: Nov 2022 Date Updated: Nov 2022
URLSupports

/{cf_uri}/Inventory/Build

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

  • UID GUID (36)
  • Unique guid identifier created for the Build adjustment journal.
    ONLY required for updating an existing Build adjustment journal.
    NOT required when creating a new inventory adjustment journal.
  • InventoryJournalNumberString (13)
  • Inventory journal number, if left null when posting a number will automatically be assigned and incremented based upon last recorded
  • DateDateTime
  • Transaction date entry, format YYYY-MM-DD HH:MM:SS { 'Date': '2013-12-04 13:33:02' }
  • Memo String (255)
  • Memo text assigned to the inventory journal adjustment.
  • Lines []
  • An array of line item information
    • RowIDInteger
    • Sequence of the entry within the inventory journal set.
      REQUIRED only when passing the RowVersion for updating an existing Build adjustment line.
    • QuantityDecimal (13.6)
    • The quantity of items to be adjusted.
    • UnitCostDecimal (13.6)
    • Unit cost assigned to the item/items, if left blank on POST will default to AverageCost.
    • AmountDecimal (13.6)
    • Dollar amount assigned to the item (Quantity * UnitCost = Amount).
    • 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.
    • Account
    • The following set of information pulls through the details for an account
      • UIDGUID (36)
      • Foreign Key: Unique guid identifier belonging to the account for the item adjustment
      • Name String (60)
      • Account name belonging to the account record
      • DisplayID String (6)
      • Account code format includes separator ie 1-1100 { 'DisplayID': '5-1100' }
      • URI String
      • Uniform resource identifier associated with the account object
    • Job
    • The following set of information pulls through details for jobs
      • UID GUID (36)
      • Foreign Key: Unique guid identifier belonging to the job for this line of the inventory journal entry
      • 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
    • MemoString (1000)
    • Memo text describing the transaction line,
    • Location
    • The following set of information pulls through details for the item associated location.
      • 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 for updating an existing inventory adjustment line.
      NOT required when creating a new inventory adjustment journal.
  • Category
  • The following outlines category information for the inventory adjustment journal.
    • UID GUID (36)
    • Foreign Key: Unique guid identifier belonging to the category assigned to the inventory journal.
    • 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
  • URI String
  • Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web
  • RowVersion String
  • 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 Build adjustment journal.
    NOT required when creating a new Build adjustment journal.


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

Example json GET response

  • {
  • "UID" : "04d3bfff-9b10-4582-815a-e331f259d0fe",
  • "InventoryJournalNumber" : "IJ000028",
  • "Date" : "2022-09-15T00:00:00",
  • "Memo" : "memo",
  • "Lines" : [
    • {
  • "RowID" : 820092,
  • "Quantity" : -1.000000,
  • "UnitCost" : 28.350000,
  • "Amount" : -28.350000,
  • "Item" : {
    • "UID" : "b9c8cac8-31fc-4038-a7d9-5d4def92fabf",
    • "Number" : "0003537",
    • "Name" : "Item 0003537",
    • "URI" : "{cf_uri}/Inventory/Item/b9c8cac8-31fc-4038-a7d9-5d4def92fabf"
    • },
  • "Account" : {
    • "UID" : "2a999859-a1fa-4bf2-a36a-488c00494389",
    • "Name" : "Goods",
    • "DisplayID" : "1-9000",
    • "URI" : "{cf_uri}/GeneralLedger/Account/2a999859-a1fa-4bf2-a36a-488c00494389"
    • },
  • "Job" : null,
  • "Memo" : "magnis ut risus eleifend dui",
  • "Location" : {
    • "UID" : "52c3d2e8-7717-4959-ad0b-0399106c07f0",
    • "Identifier" : "Location1",
    • "Name" : "Primary Location",
    • "URI" : "{cf_uri}/Inventory/Location/52c3d2e8-7717-4959-ad0b-0399106c07f0"
    • },
  • "RowVersion" : "-4065061613655293952"
  • }
  • ],
  • "Category" : {
    • "UID" : "b211a2a3-0be9-477c-940e-1c8bac139cf1",
    • "Name" : "Melbourne",
    • "DisplayID" : "CAT101",
    • "URI" : "{cf_uri}/GeneralLedger/Category/b211a2a3-0be9-477c-940e-1c8bac139cf1"
    • },
  • "URI" : "{cf_uri}/Inventory/Build/04d3bfff-9b10-4582-815a-e331f259d0fe",
  • "RowVersion" : "-6730279998407573504"
  • }
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.