TimeBilling

Return, create, update and delete time billing type sale orders.

Date Released: Oct 2014 Date Updated: Jan 2022
URLSupports
/{cf_uri}/Sale/Order/TimeBilling 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 TimeBilling. 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 time billing order.
    ONLY required for updating an existing time billing order.
    NOT required when creating a new time billing order.
  • Number String (13)
  • Sale order number
  • DateDateTime
  • Transaction date entry, format YYYY-MM-DD HH:MM:SS { 'Date': '2014-09-21 00:00:00' }
  • ShipToAddressString (255)
  • ShipTo address of the sale order.
  • 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 time billing sale.
    • NameString (50)
    • Name of the customer.
    • URIString
    • Uniform resource identifier associated with the customer object.
  • Terms
  • The following set of information pulls through customer payment terms.

    Please note: When posting a new sale order, if you do not set the terms, default payment terms from the customer 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 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.
    • 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.
  • IsTaxInclusiveBoolean
  • True indicates the transaction is tax inclusive.

    False indicates the transaction is not tax inclusive.
  • Lines []
  • An array of line order information
    • RowID Integer
    • Sequence of the entry within the time billing sale order set.
      ONLY required for updating an existing line entry.
    • TypeString
    • Order 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 activty or item used on the sale line.
    • DateDateTime
    • Date attached to the line entry., format YYYY-MM-DD HH:MM:SS { 'Date': '2014-09-23 00:00:00' }
    • HoursDecimal (13.2)
    • Number of hours to be billed for the activity if the sale line is based upon an activity.
      ONLY required when using activity on the sale line.
    • Actvity
    • The following set of information pulls through details for an activity
      • UIDGuid (36)
      • Foreign Key: Unique identifier for the activity in the form of a guid.
        ONLY required when using activity on the sale line.
      • NameString (30)
      • Activity name.
      • URIString
      • Uniform resource identifier associated with the activity object.
    • UnitsDecimal (13.2)
    • Number of units to be billed for an item if the sale line is based upon item, check company preference I include Items on TimeBilling Invoices

      ONLY required when using items on the sale line.
    • 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 sale line.
      • NumberString (15)
      • Number assigned to the item.
      • NameString (25)
      • Name assigned to the item.
      • URIString
      • Uniform resource identifier associated with the item object.
    • RateDecimal (13.2)
    • Billing rate for the activity, or if using item then the default selling price as per the customer contacts selling details.
    • TotalDecimal (13.2)
    • When both Rate and Unit are supplied Total = Unit * Rate
    • 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 of the time billing sale.
      • 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
    • 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.
    • RowVersionString
    • ONLY required for updating an existing line entry
  • 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.
  • FreightDecimal (13.2)
  • Tax inclusive freight amount applicable to the sale order.
  • 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 time billing order.
  • TotalAmountDecimal (13.2)
  • Total amount of the time billing order.
  • Category
  • The following outlines category information for the sale order.
    • UID GUID (36)
    • Foreign Key: Unique guid identifier belonging to the category assigned to the sale order
    • 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 (50)
    • Selected employee contact name.
    • DisplayIDString (15)
    • Employee contact Card ID, can also be used as a unique employee contact identifier.
    • URIString
    • Uniform resource identifier associated with the employee contact object.
  • CommentString (2000)
  • Sale order comment.
  • ShippingMethodString (20)
  • Shippinh method text.
  • JournalMemoString (255)
  • Journal memo text describing the sale.
  • PromisedDateDateTime
  • Transaction promised date, format YYYY-MM-DD HH:MM:SS { 'PromisedDate': '2014-08-21 00:00:00' }
  • DeliveryStatusString (20)
  • Order delivery status assigned:
    Print = ToBePrinted
    Email = ToBeEmailed
    PrintAndEmail = ToBePrintedAndEmailed
    Nothing = AlreadyPrintedOrSent
  • ReferralSourceString (20)
  • Referral Source selected on the time billing order.
  • AppliedToDateDecimal (13.2)
  • Payment amount already applied to sale order.
  • BalanceDueAmountDecimal (13.2)
  • Amount still payable on the sale order.
  • StatusString
  • Order status can consist of the following:
    Open
    ConvertedToInvoice
  • LastPaymentDateDateTime
  • The most recent invoice payment, format YYYY-MM-DD HH:MM:SS
  • LastModifiedDateTime
  • DateTime of the last time this resource was modified through a direct action to the object. eg a field was updated.
  • 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 time billing order.
    NOT required when creating a new time billing order.


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

Example json GET response

  • {
  • "UID" : "0c55818c-855a-452e-be92-d8a1595fc5e9",
  • "Number" : "00010598",
  • "Date" : "2014-08-23T00:00:00",
  • "ShipToAddress" : "Island Way Motel 22 Campbell Way Hornsby NSW 2034",
  • "CustomerPurchaseOrderNumber" : "00009115",
  • "Customer" : {
    • "UID" : "bda2dcf4-4db1-4f82-b208-5f9a8708fe5a",
    • "Name" : "Island Way Motel",
    • "URI" : "{cf_uri}/Contact/Customer/bda2dcf4-4db1-4f82-b208-5f9a8708fe5a"
    • },
  • "Terms" : {
    • "PaymentIsDue" : "DayOfMonthAfterEOM",
    • "DiscountDate" : 1,
    • "BalanceDueDate" : 30,
    • "DiscountForEarlyPayment" : 0,
    • "MonthlyChargeForLatePayment" : 10,
    • "DiscountExpiryDate" : "2014-09-01T00:00:00",
    • "Discount" : 0,
    • "DueDate" : "2014-09-30T00:00:00",
    • "FinanceCharge" : 0
    • },
  • "IsTaxInclusive" : true,
  • "Lines" : [
    • {
    • "RowID" : 105,
    • "Type" : "Transaction",
    • "Description" : "Service Hourly",
    • "Date" : "2014-08-23T00:00:00",
    • "Hours" : 8,
    • "Activity" : {
      • "UID" : "c6c3cef4-36fc-4de6-98e0-4e0371e0d2c1",
      • "Name" : "Service 1",
      • "URI" : "{cf_uri}/TimeBilling/Activity/c6c3cef4-36fc-4de6-98e0-4e0371e0d2c1"
      • },
    • "Units" : null,
    • "Item" : null,
    • "Rate" : 25.45,
    • "Total" : 203.60,
    • "Job" : null,
    • "TaxCode" : {
      • "UID" : "38a37ae8-565c-46f8-ad4a-2a87069607f8",
      • "Code" : "GST",
      • "URI" : "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8"
      • },
    • "RowVersion" : "-3815615201405906955"
    • }
    • ],
    • "Subtotal" : 203.60,
    • "Freight" : 0,
    • "FreightTaxCode" : {
      • "UID" : "38a37ae8-565c-46f8-ad4a-2a87069607f8",
      • "Code" : "GST",
      • "URI" : "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8"
      • },
    • "TotalTax" : 18.51,
    • "TotalAmount" : 203.60,
    • "Category" : {
      • "UID" : "b211a2a3-0be9-477c-940e-1c8bac139cf1",
      • "Name" : "Melbourne",
      • "DisplayID" : "CAT101",
      • "URI" : "{cf_uri}/GeneralLedger/Category/b211a2a3-0be9-477c-940e-1c8bac139cf1"
      • },
    • "Salesperson" : {
      • "UID" : "22985a06-eeaa-4634-89ef-ee4ff314f406",
      • "Name" : "Alan Long",
      • "DisplayID" : "EMP00002",
      • "URI" : "{cf_uri}/Contact/Employee/22985a06-eeaa-4634-89ef-ee4ff314f406"
      • },
    • "Comment" : "Thank you!",
    • "ShippingMethod" : "Freight",
    • "JournalMemo" : "Sale; Island Way Motel",
    • "PromisedDate" : "2014-08-21T00:00:00",
    • "DeliveryStatus" : "Print",
    • "ReferralSource" : "Brochure",
    • "AppliedToDate" : 0,
    • "BalanceDueAmount" : 203.60,
    • "Status" : "Open",
    • "LastPaymentDate" : null,
    • "LastModified" : "2019-05-01T00:47:43.757",
    • "URI" : "{cf_uri}/Sale/Order/TimeBilling/0c55818c-855a-452e-be92-d8a1595fc5e9",
    • "RowVersion" : "-4203855366557618651"
    • }
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.