Company

Returns company information details.

Date Released: Nov 2013 Date Updated: Jan 2022
URLSupports
/{cf_uri}/Company 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 Company. 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

  • CompanyNameString (40)
  • Company name as entered within the Company Information window.
  • SerialNumberInteger
  • The AccountRight product serial number unique to your subscription.
    AU region starts as 61 where as the NZ region starts with 64
  • AddressString (255)
  • Address as entered within the Company Information window.
  • PhoneNumberString (20)
  • Phone number as entered within the Company Information window.
  • FaxNumberString (20)
  • Fax number as entered within the Company Information window.
  • EmailAddressString (255)
  • Email address as entered within the Company Information window.
  • ABNOrTFNString (14)
  • ABN or TFN as entered within the Company Information window.
  • ABNBranchString (11)
  • ABN Branch as entered within the Company Information window.
  • ACNString (19)
  • ACN as entered within the Company Information window.
  • SalesTaxNumberString (19)
  • SalesTaxNumber as entered within the Company Information window
  • PayeeNumberString (8)
  • Payee Number as entered within the Company Information window.
  • ReadOnlyBoolean
  • Indicates if the company file license has expired or the online file has been checked out.
  • RowVersionString
  • Incrementing number that can be used for change control but does does not preserve a date or a time.

Example json GET response

  • {
  • "CompanyName" : "Clearwater Pty Ltd",
  • "SerialNumber" : "610456761234",
  • "Address" : "25 Spring Street Blackburn VIC 3130",
  • "PhoneNumber" : "03 9555 4567",
  • "FaxNumber" : "03 9555 4566",
  • "EmailAddress" : "info@clearwater.com.au",
  • "ABNOrTFN" : "80 000 000 001",
  • "ABNBranch" : "123",
  • "ACN" : "",
  • "SalesTaxNumber" : "",
  • "PayeeNumber" : "",
  • "ReadOnly" : false,
  • "RowVersion" : "-8202462296325226496"
  • }