Invoice

Return all sale invoice types

Date Released: Aug 2013 Date Updated: Jan 2022
URLSupports
/{cf_uri}/Sale/Invoice 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 Invoice. 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 sale invoice.
  • Number String (13)
  • Sales invoice number
  • DateDateTime
  • Transaction date entry, format YYYY-MM-DD HH:MM:SS { 'Date': '2013-08-11 13:33:02' }
  • 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 sale invoice.
    • NameString (50)
    • Name of the customer.
    • DisplayIDString (15)
    • Customer contact Card ID.
    • URIString
    • Uniform resource identifier associated with the customer object.
  • PromisedDateDateTime
  • Transaction promised date, format YYYY-MM-DD HH:MM:SS { 'PromisedDate': '2013-11-12 13:33:02' }
  • BalanceDueAmountDecimal (13.2)
  • Amount still payable on the sale invoice.
  • BalanceDueAmountForeignDecimal (13.2)
  • Foreign Currency amount still payable on the sale invoice.
  • StatusString
  • Invoice status:
    Open
    Closed
    Credit
  • ShipToAddressString (255)
  • ShipTo address of the sale invoice.
  • Terms
  • The following set of information pulls through customer 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 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': '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 that will apply if payment is made in full by the discount date in Foreign Currency
    • DueDateDateTime
    • Date in which payment is due, format YYYY-MM-DD HH:MM:SS { 'Date': '2014-09-10 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 if payment is not made in full by the due date in Foreign Currency
  • IsTaxInclusiveBoolean
  • True indicates the transaction is set to tax inclusive.
    Falseindicates the transaction is not tax inclusive.
  • 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)
  • Subtotal of the Invoice lines in Foreign Currency.
  • FreightDecimal (13.2)
  • Freight applicable to the sale invoice.
  • FreightForeignDecimal (13.2)
  • Amount for freight applicable to the sale invoice 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 invoice.
  • TotalTaxForeignDecimal (13.2)
  • Total of all tax amounts applicable to the sale invoice in Foreign Currency.
  • TotalAmountDecimal (13.2)
  • Total amount of the sale invoice.
  • TotalAmountForeignDecimal (13.2)
  • Total amount of the sale invoice in Foreign Currency
  • Category
  • The following outlines category information for the sale invoice.
    • UID GUID (36)
    • Foreign Key: Unique guid identifier belonging to the category assigned to the sale invoice
    • 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
    • URIString
    • Uniform resource identifier associated with the employee contact object.
  • CommentString (2000)
  • Sale invoice comment.
  • ShippingMethodString (20)
  • Shipping method text.
  • JournalMemoString (255)
  • Journal memo text describing the sale.
  • ReferralSourceString (20)
  • Referral Source selected on the sale invoice.
  • InvoiceDeliveryStatusString (20)
  • Invoice delivery status assigned:
    Print = ToBePrinted
    Email = ToBeEmailed
    PrintAndEmail = ToBePrintedAndEmailed
    Nothing = AlreadyPrintedOrSent
  • LastPaymentDateDateTime
  • The most recent invoice payment, format YYYY-MM-DD HH:MM:SS
  • InvoiceTypeInvoiceType
  • Invoice layout type:
    Item
    Service
    Professional
    TimeBilling
    Miscellaneous
  • Order
  • Please note: This field will default to null for any new invoice created without an order conversion.
    • UIDGuid (36)
    • Foreign Key: Unique sale order identifier in the form of a guid.
    • NumberString (8)
    • Sales order number.
    • URIString
    • Uniform resource identifier associated with the sale order object.
  • OnlinePaymentMethodString
  • Which Online Payment Methods should be turned on for this resource. Values can be 'All' or 'None'.
  • ForeignCurrency
  • Null if no foreign currency is set.
    • 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 (13.2)
  • The exchange rate between the Local and Foreign currency
  • 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" : "243c1c35-f2f2-4745-ab01-1ed5a7ee13c0",
  • "Number" : "SJ000302",
  • "Date" : "2013-08-23T19:00:59.043",
  • "CustomerPurchaseOrderNumber" : "90000117",
  • "Customer" : {
    • "UID" : "9884b884-e08e-4d17-99c6-1b3c4a5b312d",
    • "Name" : "Chris Davis",
    • "DisplayID" : "CUS000004",
    • "URI" : "{cf_uri}/Contact/Customer/9884b884-e08e-4d17-99c6-1b3c4a5b312d"
    • },
  • "PromisedDate" : "2013-08-30T19:00:59.043",
  • "BalanceDueAmount" : 45,
  • "BalanceDueAmountForeign" : null,
  • "Status" : "Open",
  • "ShipToAddress" : "Chris Davis 45 Hemley Street Brunswick Vic 3000",
  • "Terms" : {
    • "PaymentIsDue" : "DayOfMonthAfterEOM",
    • "DiscountDate" : 1,
    • "BalanceDueDate" : 30,
    • "DiscountForEarlyPayment" : 5,
    • "MonthlyChargeForLatePayment" : 0,
    • "DiscountExpiryDate" : "2013-09-01T00:00:00",
    • "Discount" : 3.63,
    • "DiscountForeign" : null,
    • "DueDate" : "2013-09-30T00:00:00",
    • "FinanceCharge" : 0
    • "FinanceChargeForeign" : null
    • },
  • "IsTaxInclusive" : true,
  • "Subtotal" : 72.5,
  • "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" : 6.59,
  • "TotalTaxForeign" : null,
  • "TotalAmount" : 72.5,
  • "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" : "Thank you!",
  • "ShippingMethod" : "Federal Express",
  • "JournalMemo" : "Sale; Chris Davis",
  • "ReferralSource" : "Internet",
  • "InvoiceDeliveryStatus" : "Print",
  • "LastPaymentDate" : "2013-09-01T00:00:00",
  • "InvoiceType" : "Service",
  • "Order" : null,
  • "OnlinePaymentMethod" : null,
  • "ForeignCurrency" : null,
  • "CurrencyExchangeRate" : null,
  • "LastModified" : "2013-08-23T19:00:59.043",
  • "URI" : "{cf_uri}/Sale/Invoice/Service/243c1c35-f2f2-4745-ab01-1ed5a7ee13c0",
  • "RowVersion" : "6166553789777051648"
  • }
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.