Companies

The Companies resource allows Companies to be listed. An individual Company details can be viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) to the URI. Here are some example URIs:

/Companies - returns a list of Company related information.

The full range of URIs and HTTP Verbs supported are:

Operation	HTTP Action
Lists all information for your company	GET `/Companies`

GET Companies

Available Fields for Companies:

Property	Type	Length	Required	Notes
BaseCurrencyCode	String	3
CompanyName	String	100
DefaultTaxRate	Nullable Decimal
Guid	Guid		Yes	Unique identifier. Can only be set when adding a record.

Examples for Request GET `/Companies`

show xml example

 
<?xml version="1.0"?>
<Companies xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.unleashedsoftware.com/version/1">
  <Company>
    <Guid>707aceb5-deda-4185-afdd-e3e9b653b32a</Guid>
    <CompanyName>Unleashed</CompanyName>
    <BaseCurrencyCode>NZD</BaseCurrencyCode>
    <DefaultTaxRate>0.150000</DefaultTaxRate>
  </Company>
</Companies>

show json example

{
    "Items": [
        {
            "Guid": "707aceb5-deda-4185-afdd-e3e9b653b32a",
            "CompanyName": "Unleashed",
            "BaseCurrencyCode": "NZD",
            "DefaultTaxRate": 0.15
        }
    ]
}

Companies

The full range of URIs and HTTP Verbs supported are:

GET Companies

Available Fields for Companies:

Examples for Request GET /Companies

Examples for Request GET `/Companies`