Item

Return, update, create and delete item type purchase bills

Date Released: Sep 2013 Date Updated: Jan 2022
URLSupports
/{cf_uri}/Purchase/Bill/Item GET |  PUT |  POST |  DELETE

Please note: While accessibility via the API is available to both AccountRight, new Essentials and MYOB Business files. Not all features will be displayed in Product for new Essentials or MYOB Business

Attention: If you are using the Hybrid layout, the Freight fields are not currently supported for AccountRight, new Essentials and MYOB Business files. To have Freight on in the transaction and use the Hybrid layout you will need to have Freight as an item on the transaction. For more information head to our knowledgebase article

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 a item purchase bill.
    ONLY required for updating an existing item purchase bill.
    NOT required when creating a new item purchase bill.
  • Number String (13)
  • Purchase bill number
  • DateDateTime
  • Transaction date entry, format YYYY-MM-DD HH:MM:SS { 'Date': '2013-09-10 13:33:02' }
  • SupplierInvoiceNumberString (255)
  • Supplier invoice number.
  • Supplier
  • The following set of information pulls through details for the Supplier contact
    • UIDGuid (36)
    • Foreign Key: Unique guid identifier belonging to the supplier assigned to the purchase bill.
    • NameString (30)
    • Name of the supplier.
    • DisplayIDString (15)
    • Supplier contact Card ID, can also be used as a unique supplier contact identifier.
    • URIString
    • Uniform resource identifier associated with the supplier object.
  • ShipToAddressString (255)
  • ShipTo address of the purchase bill.
  • Terms
  • The following set of information pulls through supplier payment terms.

    Please note: When posting a new purchase bill, if you do not set the terms, default payment terms from the supplier 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 payments must be made 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 payments must be made.

      If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which payments must be made.
    • 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': '2013-09-10 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-09-10 00:00:00' }
  • 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.
  • IsReportableBoolean
  • ONLY APPLICABLE FOR AU REGION.
    True indicates the transaction is reportable taxable payment.
    False indicates the transaction is not reportable taxable payment.
    What are taxable payments?
  • Lines []
  • An array of line bill information
    • RowID Integer
    • Sequence of the entry within the item purchase set.
      REQUIRED only when passing the RowVersion for updating an existing item bill line.
    • TypeString
    • Bill 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 purchase line.
    • BillQuantityDecimal (13.6)
    • The quantity of goods shipped.
    • ReceivedQuantityDecimal (13.6)
    • The quantity of goods received.
    • BackorderQuantityDecimal (13.6)
    • Please note: To be implemented when Purchase Order functionality is available.
    • TotalDecimal (13.2)
    • Mandatory for a Local currency record : Total amount for the line item only.
    • TotalForeignDecimal (13.2)
    • Total amount in foreign currency for the line item only.
    • UnitPriceDecimal (13.6)
    • Unit price assigned to the item.
    • UnitsOfMeasureString (5)
    • Unit of measure assigned to the service.
    • UnitCountDecimal (13.6)
    • Unit count assigned to the service. ONLY required when using Account on the service purchase line.
    • UnitPriceForeignDecimal (13.6)
    • Mandatory for a Foreign currency record : Unit price assigned to the item in foreign currency.
    • 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.
      • 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
    • DiscountPercentDouble (99.99%)
    • Discount rate applicable to the line of the purchase bill.
    • 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.
    • 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.
        ONLY required when using Item on the item purchase line.
      • 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 details for an Account
      • UIDGuid (36)
      • Foreign Key: Unique identifier for the account in the form of a guid.
        ONLY required when using Account on the item purchase line.
      • NameString (60)
      • Account name belonging to the account record.
      • DisplayIDString (6)
      • Account code format includes separator ie 1-1100{ 'DisplayID': '1-1200' }
      • URIString
      • Uniform resource identifier associated with the account 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.
    • 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 for updating an existing item purchase bill line.
      NOT required when creating a new item purchase bill.
  • 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 purchase bill.
  • FreightForeignDecimal (13.2)
  • Amount for freight applicable to the purchase bill 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 purchase bill.
  • TotalTaxForeignDecimal (13.2)
  • Total of all tax amounts applicable to the purchase bill in Foreign Currency.
  • TotalAmountDecimal (13.2)
  • Total amount of the purchase bill.
  • TotalAmountForeignDecimal (13.2)
  • Total amount of the purchase bill in Foreign Currency
  • Category
  • The following outlines the category information for the puchase bill.
    • UID GUID (36)
    • Foreign Key: Unique guid identifier belonging to the category assigned to the purchase bill
    • 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
  • CommentString (2000)
  • Purchase bill comment.
  • ShippingMethodString (20)
  • Shipping method text.
  • PromisedDateDateTime
  • Transaction promised date, format YYYY-MM-DD HH:MM:SS { 'PromisedDate': '2013-12-12 14:22:09' }
  • JournalMemoString (255)
  • Journal memo text describing the bill.
  • BillDeliveryStatusString (20)
  • Bill delivery status assigned:
    Print = ToBePrinted
    Email = ToBeEmailed
    PrintAndEmail = ToBePrintedAndEmailed
    Nothing = AlreadyPrintedOrSent
  • AppliedToDateDecimal (13.2)
  • All amounts currently applied to the purchase bill.
  • AppliedToDateForeignDecimal (13.2)
  • All amounts currently applied to the purchase bill in foreign currency.
  • BalanceDueAmountDecimal (13.2)
  • Amount still payable on the purchase bill.
  • BalanceDueAmountForeignDecimal (13.2)
  • Amount still payable on the purchase bill in foreign currency.
  • StatusString
  • Bill status:
    Open
    Closed
    Debit
  • LastPaymentDateDateTime
  • The most recent bill payment, format YYYY-MM-DD HH:MM:SS
  • Order
  • REQUIRED ONLY if converting an existing item purchase order to a bill. For details visit here.
    Please note: This field will default to null for any new item purchase bill created without an order conversion.
    • UIDGuid (36)
    • REQUIRED ONLY if converting an existing item purchase order to a bill.
      Foreign Key: Unique purchase order identifier in the form of a guid.
    • NumberString (8)
    • Purchase order number.
    • URIString
    • Uniform resource identifier associated with the purchase order object.
  • 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.
  • 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 purchase bill.
    NOT required when creating a new item purchase bill.


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

Example json GET response

  • {
  • "UID" : "b942931a-1f29-4db2-9b71-135a5fc46b7e",
  • "Number" : "00000015",
  • "Date" : "2014-08-11T00:00:00",
  • "SupplierInvoiceNumber" : "AAA000005899813",
  • "Supplier" : {
    • "UID" : "63b984e5-241e-4c1a-bfe1-7868a69f5e29",
    • "Name" : "Huston & Huston Packaging",
    • "DisplayID" : "SUPP000004",
    • "URI" : "{cf_uri}/Contact/Supplier/63b984e5-241e-4c1a-bfe1-7868a69f5e29"
    • },
  • "ShipToAddress" : "Clearwater Pty. Ltd. 25 Spring Street Blackburn VIC 3130",
  • "Terms" : {
    • "PaymentIsDue" : "DayOfMonthAfterEOM",
    • "DiscountDate" : 1,
    • "BalanceDueDate" : 30,
    • "DiscountForEarlyPayment" : 0
    • "MonthlyChargeForLatePayment" : 0,
    • "DiscountExpiryDate" : "2014-09-01T00:00:00",
    • "Discount" : 0,
    • "DiscountForeign" : null,
    • "DueDate" : "2014-09-30T00:00:00"
    • },
  • "IsTaxInclusive" : true,
  • "IsReportable" : false,
  • "Lines" : [
    • {
  • "RowID" : 1054,
  • "Type" : "Transaction",
  • "Description" : "Cooler Filter Large",
  • "BillQuantity" : 1000,
  • "ReceivedQuantity" : 1000,
  • "BackorderQuantity" : 0,
  • "Total" : 19990,
  • "TotalForeign" : null,
  • "UnitPrice" : 19.99,
  • "UnitOfMeasure" : null,
  • "UnitCount" : null,
  • "UnitPriceForeign" : null.,
  • "Job" : null,
  • "DiscountPercent" : 0,
  • "TaxCode" : {
    • "UID" : "38a37ae8-565c-46f8-ad4a-2a87069607f8",
    • "Code" : "GST",
    • "URI" : "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8"
    • },
  • "Item" : {
    • "UID" : "ddf9c9b8-5ea4-4495-a9cb-094f3d8846cb",
    • "Number" : 120,
    • "Name" : "Cooler Filter Large",
    • "URI" : "{cf_uri}/Inventory/Item/ddf9c9b8-5ea4-4495-a9cb-094f3d8846cb"
    • },
  • "Location" : {
    • "UID" : "04ad68a3-91f5-4739-8b83-13f86ecd2e33",
    • "Identifier" : "Location1",
    • "Name" : "Primary Location",
    • "URI" : "{cf_uri}"
    • },
  • "RowVersion" : "8460293374992187392"
  • }
  • ],
  • "Subtotal" : 19990,
  • "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" : 1817.27,
  • "TotalTaxForeign" : null,
  • "TotalAmount" : 19990,
  • "TotalAmountForeign" : null,
  • "Category" : null,
  • "Comment" : "Thank you!",
  • "ShippingMethod" : "Federal Express",
  • "PromisedDate" : null,
  • "JournalMemo" : "Purchase; Huston & Huston Packaging",
  • "BillDeliveryStatus" : "Print",
  • "AppliedToDate" : 0,
  • "AppliedToDateForeign" : null,
  • "BalanceDueAmount" : 19990,
  • "BalanceDueAmountForeign" : null,
  • "Status" : "Open",
  • "LastPaymentDate" : null,
  • "Order" : {
    • "UID" : "0611bdac-9608-47f7-a296-7ad15597da62",
    • "Number" : "00000012",
    • "URI" : "{cf_uri}/Purchase/Order/0611bdac-9608-47f7-a296-7ad15597da62"
    • },
  • "ForeignCurrency" : null,
  • "CurrencyExchangeRate" : null,
  • "URI" : "{cf_uri}/Purchase/Bill/Item/b942931a-1f29-4db2-9b71-135a5fc46b7e",
  • "RowVersion" : "-3357433522204704768"
  • }
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.