Business

This business resource allows retrieving and updating the general information about your business, such as contact details and billing address. This is also the place to set the default currency, and the tax system under which the business operates. There is only one business resource per account. It can not be deleted.

Get Business

GET /business

Retrieve general information about the business

Sample request:

GET /business HTTP/1.1
Host: api.fieldaware.net
Authorization: Token 9dcae3660ec84eac94bb506e09a9af40
Accept: application/json

Sample response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "defaultCurrency": "USD",
  "email": "biz@murphy.com",
  "fax": "041-6857771",
  "name": "Murphy Ltd",
  "phone": "214-447-0289",
  "taxSystem": "US",
  "vatRegistrationNumber": "US-556677",
  "billingAddress":
    {
      "country": "United States",
      "region": "Texas",
      "postcode": "75070",
      "streetName": "1909 Clinton Drive",
      "locality": "McKinney"
    }
}
Status Codes:

  • 200 OK – Request successful

Update Business

PUT /business

Update information about the business.

Sample request:

PUT /business HTTP/1.1
Host: api.fieldaware.net
Authorization: Token 9dcae3660ec84eac94bb506e09a9af40
Accept: application/json

{
  "defaultCurrency": "USD",
  "email": "foo@gmail.com",
  "fax": "000",
  "name": "name",
  "phone": "000",
  "taxSystem": "US",
  "vatRegistrationNumber": "dd33",
  "billingAddress":
    {
      "streetName": "Street name",
      "locality": "locality",
      "region": "region",
      "postcode": "post code example here",
      "country": "country here",
    }
}
Request JSON Object:

  • defaultCurrency (string) – Default currency of the business

  • email (string) – A contact email of the business

  • fax (string) – A contact fax number of the business

  • name (string) – The name of the business

  • phone (string) – A contact phone number of the business

  • taxSystem (string) – Code defining the tax system, one of IRL, US, UK, AU, CAN, null

  • vatRegistrationNUmber (string) – VAT registration number of the business

  • billingAddress (object) – JSON object representing a billing address :<json string billingAddress.streetName: Street name and number of the business

  • billingAddress.locality (string) – Locality of the business

  • billingAddress.region (string) – Region of the business

  • billingAddress.postcode (string) – Post code of the business

  • billingAddress.country (string) – Country of the business

Status Codes: