Bill

Return all purchase bill types.

Date Released: Sep 2013 Date Updated: Jan 2022
URLSupports
/{cf_uri}/Purchase/Bill 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

The elements list below details information for Bill. 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 purchase bill.
  • Number String (13)
  • Purchase bill number
  • DateDateTime
  • Transaction date entry, format YYYY-MM-DD HH:MM:SS { 'Date': '2013-08-11 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.
    • 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.
    • 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 set to tax inclusive.
    False indicates the transaction is not tax inclusive.
  • IsReportableBoolean
  • ONLY applicable for AU region.
    True indicates the transaction is reportable taxable payment.
    Falseindicates the transaction is not reportable taxable payment.
    What are taxable payments?
  • 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)
  • Tax inclusive freight amount 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 this 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-11-12 13:33:02' }
  • JournalMemoString (255)
  • Journal memo text describing the purchase.
  • BillDeliveryStatusString (20)
  • Bill delivery status assigned:
    Print = ToBePrinted
    Email = ToBeEmailed
    PrintAndEmail = ToBePrintedAndEmailed
    Nothing = AlreadyPrintedOrSent
  • AppliedToDateDecimal (13.2)
  • Amount currently applied to the purchase bill.
  • AppliedToDateForeignDecimal (13.2)
  • Amount 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
  • BillTypeBillType
  • Bill layout type:
    Item
    Service
    Professional
    Miscellaneous
  • Order
  • Please note: This field will default to null for any new purchase bill created without an order conversion.
    • UIDGuid (36)
    • 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.


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

Example json GET response

  • {
  • "UID" : "75c8f884-bd49-4c39-a987-e2a818d98e13",
  • "Number" : "00000009",
  • "Date" : "2014-08-11T00:00:00",
  • "SupplierInvoiceNumber" : "AAA000005899718",
  • "Supplier" : {
    • "UID" : "a1ea92fd-8f22-4be6-992c-4e078871091e",
    • "Name" : "Clear & Bright Filters",
    • "DisplayID" : "SUPP000002",
    • "URI" : "{cf_uri}/Contact/Supplier/a1ea92fd-8f22-4be6-992c-4e078871091e"
    • },
  • "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.0,
    • "DiscountForeign" : null,
    • "DueDate" : "2014-09-30T00:00:00"
    • },
  • "IsTaxInclusive" : true,
  • "IsReportable" : false,
  • "Subtotal" : 129.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" : 11.8,
  • "TotalTaxForeign" : null,
  • "TotalAmount" : 129.75,
  • "TotalAmountForeign" : null,
  • "Category" : {
    • "UID" : "b211a2a3-0be9-477c-940e-1c8bac139cf1",
    • "Name" : "Victoria",
    • "DisplayID" : "API101",
    • "URI" : "{cf_uri}/GeneralLedger/Category/b211a2a3-0be9-477c-940e-1c8bac139cf1"
    • },
  • "Comment" : "We appreciate your business.",
  • "ShippingMethod" : "Australia Post",
  • "PromisedDate" : null,
  • "JournalMemo" : "Purchase; Clear & Bright Filters",
  • "BillDeliveryStatus" : "Email",
  • "AppliedToDate" : 0,
  • "AppliedToDateForeign" : null,
  • "BalanceDueAmount" : 129.75,
  • "BalanceDueAmountForeign" : null,
  • "Status" : "Open",
  • "LastPaymentDate" : null,
  • "BillType" : "Item",
  • "Order" : {
    • "UID" : "f3bf0f67-a665-45f4-b2db-2786fc1d851c",
    • "Number" : "00000010",
    • "URI" : "{cf_uri}/Purchase/Order/f3bf0f67-a665-45f4-b2db-2786fc1d851c"
    • },
  • "ForeignCurrency" : null,
  • "CurrencyExchangeRate" : null,
  • "URI" : "{cf_uri}/Purchase/Bill/Item/75c8f884-bd49-4c39-a987-e2a818d98e13",
  • "RowVersion" : "-1988339235484073984"
  • }
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.