TaxCode

Return, update, create and delete tax codes setup.

Date Released: Dec 2013 Date Updated: Dec 2020
URLSupports
/{cf_uri}/GeneralLedger/TaxCode 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

Please note: Only the GET method is supported for new Essentials

The elements list below details information for TaxCode. 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 tax code identifier in the form of a guid.
    ONLY required for updating an existing tax code.
    NOT required when creating a new tax code.
  • CodeString (3)
  • 3 digit code assigned to the tax code.
  • DescriptionString (30)
  • Description given to the tax code.
  • TypeTaxCodeType
  • Tax Types consist of the following:
    ImportDuty
    SalesTax
    GST_VAT (Goods and Services Tax)
    InputTaxed
    Consolidated
    LuxuryCarTax
    WithholdingsTax
    NoABN_TFN
  • RateDecimal (8.4)
  • Rate of tax assigned
  • IsRateNegativeBoolean
  • True indicates the tax rate is a negative value.
    False indicates the tax rate is a positive value.
  • TaxCollectedAccount
  • The following set of information pulls through tax collected account details.
    • UIDGuid (36)
    • Foreign Key: Unique identifier for the account in the form of a guid for tax collected.
    • NameString (60)
    • Name of the account for tax collected.
    • DisplayIDString (6)
    • Account code format includes separator ie 1-1100
    • URI String
    • Uniform resource identifier associated with the account object.
  • TaxPaidAccount
  • The following set of information pulls through tax paid account details.
    • UIDGuid (36)
    • Foreign Key: Unique identifier for the account in the form of a guid for tax paid.
    • NameString (60)
    • Name of the account for tax paid.
    • DisplayIDString (6)
    • Account code format includes separator ie 1-1100
    • URI String
    • Uniform resource identifier associated with the account object.
  • WithholdingCreditAccount
  • The following set of information pulls through withholding credit account details.
    • UIDGuid (36)
    • Foreign Key: Unique identifier for the account in the form of a guid for withholding credits.
    • NameString (60)
    • Name of the account for withholding credits.
    • DisplayIDString (6)
    • Account code format includes separator ie 1-1100
    • URI String
    • Uniform resource identifier associated with the account object.
  • WithholdingPayableAccount
  • The following set of information pulls through withholding payable account details.
    • UIDGuid (36)
    • Foreign Key: Unique identifier for the account in the form of a guid for withholding payables.
    • NameString (60)
    • Name of the account for withholding payables.
    • DisplayIDString (6)
    • Account code format includes separator ie 1-1100
    • URI String
    • Uniform resource identifier associated with the account object.
  • ImportDutyPayableAccount
  • The following set of information pulls through import duty payable account details.
    • UIDGuid (36)
    • Foreign Key: Unique identifier for the account in the form of a guid.for import duty payables.
    • NameString (60)
    • Name of the account for import duty payables.
    • DisplayIDString (6)
    • Account code format includes separator ie 1-1100
    • URI String
    • Uniform resource identifier associated with the account object.
  • LinkedSupplier
  • The following set of information pulls through linked supplier details.
    • UIDGuid (36)
    • Foreign Key: Supplier contact unique guid identifier.
    • NameString (10)
    • Supplier contact name.
    • DisplayIDString (15)
    • Supplier contact Card ID, can also be used as a unique supplier contact identifier.
    • URIString
    • Uniform resource identifier associated with the supplier contact object.
  • LuxuryCarTaxThresholdDecimal (13.6)
  • Dollar value which must be exceeded before tax is calculated using this tax code.
  • 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 tax code.
    NOT required when creating a new tax code.

Example json GET response

  • {
    • "UID" : "780a1c74-e557-4bf5-afeb-8ef819c84f8e",
    • "Code" : "ABN",
    • "Description" : "No ABN Withholding",
    • "Type" : "NoABN_TFN",
    • "Rate" : 46.5,
    • "IsRateNegative" : false,
    • "TaxCollectedAccount" : null,
    • "TaxPaidAccount" : null,
    • "WithholdingCreditAccount" : {
      • "UID" : "75ca13ce-96ec-4d79-82e8-c94f5c8d974a",
      • "Name" : "ABN Withholding Credits",
      • "DisplayID" : "1-1350",
      • "URI" : "{cf_uri}/GeneralLedger/Account/75ca13ce-96ec-4d79-82e8-c94f5c8d974a"
      • },
    • "WithholdingPayableAccount" : {
      • "UID" : "e1b278bb-9ba3-4d2a-8dda-a49d09dcc471",
      • "Name" : "ABN Withholdings Payable",
      • "DisplayID" : "2-1320",
      • "URI" : "{cf_uri}/GeneralLedger/Account/e1b278bb-9ba3-4d2a-8dda-a49d09dcc471"
      • },
    • "ImportDutyPayableAccount" : null,
    • "LinkedSupplier" : null,
    • "LuxuryCarTaxThreshold" : 0,
    • "LastModified" : "2019-05-01T00:47:43.757",
    • "URI" : "{cf_uri}/GeneralLedger/TaxCode/780a1c74-e557-4bf5-afeb-8ef819c84f8e",
    • "RowVersion" : "-7133420334778155008"
    • }
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.