Activity

Return, update, create and delete a list of time billing activities

Date Released: May 2014 Date Updated: Jan 2021
URLSupports
/{cf_uri}/TimeBilling/Activity 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 Activity. 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 an activity.
    ONLY required for updating an existing activity.
    NOT required when creating a new activity.
  • DisplayIDString (30)
  • The Activity ID
  • NameString (30)
  • The Activity name.
  • DescriptionString (255)
  • Description of the activity.
  • IsActiveBoolean
  • True indicates the activity is active.
    False indicates the activity is inactive.
  • TypeString (255)
  • Type indicates if activity is tracked with units of time:
    Hourly
    NonHourly
  • UnitOfMeasurementString (255)
  • Hourly - If Type = Hourly then UnitOfMeasurement = Hour
    NonHourly - specify the type of measurement
  • StatusString (255)
  • Can consist of the following:
    Chargeable used to include on time billing invoices.
    NonChargeable used when not charging customers but still wanting to include on activity slip.
  • ChargeableDetails
  • The following set of information pulls through details for chargeable activity information. Required if Status = Chargeable
    • UseDescriptionOnSalesBoolean
    • True indicates the activity description is to be used in the notes field of time billing invoices.
      False indicates the description is not to be used on the notes field of time billing invoices.
    • IncomeAccount
    • The following set of information pulls through details for the Income Account
      • UIDGuid (36)
      • Foreign Key: Unique identifier for the account in the form of a guid.
      • NameString (30)
      • Account name belonging to the account record.
      • DisplayIDString (6)
      • Account code format includes separator ie 1-1100{ 'DisplayID': '1-1100' }
      • URIString
      • Uniform resource identifier associated with the account object.
    • TaxCode
    • The following set of information pulls through 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.
    • RateString
    • Rate which can consit of the following:
      EmployeeBillingRate - sourced from the employee contact card
      CustomerBillingRate - sourced from the customer contact card
      ActivityRate - entered on activity and is exclusive of tax
    • ActivityRateExcludingTaxDecimal (13.2)
    • Only available If Rate = ActivityRate
      Amount charged for one unit of the activity.
  • 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.
  • RowVersion String
  • Incrementing number that can be used for change control but does does not preserve a date or a time.
    ONLY required for updating an existing activity.
    NOT required when creating a new activity.


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

Example json GET response

  • {
  • "UID" : "a6a6239d-b051-49cb-979c-8d850e4bfdcb",
  • "DisplayID" : "Service01",
  • "Name" : "Service-VIC",
  • "Description" : "VIC service department",
  • "IsActive" : true,
  • "Type" : "Hourly",
  • "UnitOfMeasurement" : "Hour",
  • "Status" : "Chargeable",
  • "ChargeableDetails" : {
    • "UseDescriptionOnSales" : false,
    • "IncomeAccount" : {
      • "UID" : "a2692ee8-bda1-4d73-8427-d2ee4071d985",
      • "Name" : "Services Income",
      • "DisplayID" : "4-1000",
      • "URI" : "{cf_uri}/GeneralLedger/Account/a2692ee8-bda1-4d73-8427-d2ee4071d985"
      • },
    • "TaxCode" : {
      • "UID" : "38a37ae8-565c-46f8-ad4a-2a87069607f8",
      • "Code" : "GST",
      • "URI" : "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8"
      • },
    • "Rate" : "EmployeeBillingRate",
    • "ActivityRateExcludingTax" : null
    • },
  • "LastModified" : "2019-05-01T00:47:43.757",
  • "URI" : "{cf_uri}/TimeBilling/Activity/a6a6239d-b051-49cb-979c-8d850e4bfdcb",
  • "RowVersion" : "-6180064588659163136"
  • }
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.