GET FileIdentity

Returns a single File Identity Detail record.

Request Information

URI Parameters

Name Description Type Additional information
WsAccessKey The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access. string

Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred.

FileId Specifies the file id of the file to perform the operation upon. integer

Required

Body Parameters

None.

Response Information

Resource Description

FileIdentityDetail
Name Description Type Additional information
Name File name used by the business in Saasu. string

None.

FullLegalName Legal registered business name. string

None.

TradingNameOrAlternativeBrandName 'Trading as' name or alternative brand name. string

None.

BusinessIdentifier Business identifier issued for the business(eg. ABN in Australia). string

None.

CompanyIdentifier Company identifier issued for the business(eg. ACN in Australia). string

None.

PrimaryPhone Primary telephone number used by the business. string

None.

Website Website used for the business. string

None.

Email Primary email of the business. string

None.

Street Street number and name of the business. string

None.

City City the business is located in. string

None.

State State the business is located in. string

None.

PostCode Postcode where the business is located. string

None.

Country The country where the business is located. string

None.

Zone Tax zone the business is operating from. string

None.

CurrencyCode Currency code of the payment eg: AUD or USD. string

None.

FileSettings Settings that specify the default behaviour for a file. FileSettings

None.

IsTaxRegistered Is the business registered for tax or not(eg: GST, VAT). boolean

None.

_links Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. Collection of Link

None.

Response Formats

application/json, text/json

Sample:
{
  "Name": "Test File",
  "FullLegalName": "Some Legal Name",
  "TradingNameOrAlternativeBrandName": "Trading test file",
  "BusinessIdentifier": "53004085616",
  "CompanyIdentifier": " 007249989",
  "PrimaryPhone": "0290125555",
  "Website": "http://somehost.com",
  "Email": "here@host.com",
  "Street": "1 brown st",
  "City": "Sydney",
  "State": "NSW",
  "PostCode": "2000",
  "Country": "Australia",
  "Zone": "Autralia",
  "CurrencyCode": null,
  "FileSettings": {
    "SaleAmountsIncludeTax": true,
    "PurchaseAmountsIncludeTax": true,
    "_links": []
  },
  "IsTaxRegistered": false,
  "_links": [
    {
      "rel": "self",
      "href": "https://api.saasu.com/FileIdentity/123",
      "method": "GET",
      "title": null
    }
  ]
}

application/xml, text/xml

Sample:
<FileIdentityDetail xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links>
    <Link>
      <rel>self</rel>
      <href>https://api.saasu.com/FileIdentity/123</href>
      <method>GET</method>
    </Link>
  </_links>
  <Name>Test File</Name>
  <FullLegalName>Some Legal Name</FullLegalName>
  <TradingNameOrAlternativeBrandName>Trading test file</TradingNameOrAlternativeBrandName>
  <BusinessIdentifier>53004085616</BusinessIdentifier>
  <CompanyIdentifier> 007249989</CompanyIdentifier>
  <PrimaryPhone>0290125555</PrimaryPhone>
  <Website>http://somehost.com</Website>
  <Email>here@host.com</Email>
  <Street>1 brown st</Street>
  <City>Sydney</City>
  <State>NSW</State>
  <PostCode>2000</PostCode>
  <Country>Australia</Country>
  <Zone>Autralia</Zone>
  <FileSettings>
    <_links />
    <SaleAmountsIncludeTax>true</SaleAmountsIncludeTax>
    <PurchaseAmountsIncludeTax>true</PurchaseAmountsIncludeTax>
  </FileSettings>
  <IsTaxRegistered>false</IsTaxRegistered>
</FileIdentityDetail>