PUT FileIdentity

Update File Identity.

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

FileIdentityDetail
Name Description Type Additional information
CreatedDateUtc The date and time that the File Identity was created in UTC. Read-only. Set by system. Not required for update. date

None.

LastUpdatedId Identifier used for concurrency checking. Required for update. string

Required

LastModifiedDateUtc The date and time that the File Identity was modified in UTC. Read-only. Set by system. date

None.

LastModifiedByUserId The user id of the user who last modified the File Identity. Read-only. Set by system. integer

None.

Name File name used by the business in Saasu. string

Required

FullLegalName Legal registered business name. string

Required

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

None.

IndustryTypeId Industry type id. integer

Required

BusinessIdentifier Business identifier issued for the business(eg. ABN in Australia). ABN is required for AU file. string

None.

BusinessIdentifierBranchNumber Business identifier branch number. In Australia, ABN Branch #. integer

None.

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

None.

PrimaryPhone Phone number. Required for AU file. E.g. 02 99999999 string

None.

Fax Fax number. 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

Required

City City the business is located in. string

Required

State State the business is located in. Required for AU file. string

None.

PostCode Postcode where the business is located. Required for AU file. string

None.

Country The country where the business is located. See LookupData/Countries. string

None.

Zone Tax zone / jurisdiction the business is operating from. Read-only. Cannot be changed after file is created. string

None.

CurrencyCode File base currency. Set based on zone by system. eg: AUD or USD. Read-only. Cannot be changed after file is created. string

None.

FileSettings [DEPRECATED] Settings that specify the default behaviour for a file. Read-only. FileSettings

None.

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

None.

TaxRegistrationDate Tax / GST registration date. If File is flagged as tax registered, then tax registration date must be specified. For AU files, they're marked as tax registered when created and default to 1 Jul 2000. date

None.

DateTimeFormatId [DEPRECATED] File date format. byte

None.

NumberFormatId [DEPRECATED] File number format. byte

None.

FinancialYearEndMonth Financial year end (FYE) month for this file. Default FYE for AU is 30 Jun. byte

None.

FinancialYearEndDate Financial year end (FYE) date for this file. Default FYE for AU is 30 Jun. byte

None.

PayrollYearEndMonth Payroll financial year end month for this file. For AU, it's 30 Jun. Cannot be changed for AU file due to STP reporting requirement. byte

None.

PayrollYearEndDate Payroll financial year end date for this file. For AU, it's 30 Jun. Cannot be changed for AU file due to STP reporting requirement. byte

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.

Request Formats

application/json, text/json

Sample:
{
  "CreatedDateUtc": null,
  "LastUpdatedId": null,
  "LastModifiedDateUtc": null,
  "LastModifiedByUserId": null,
  "Name": "Test File",
  "FullLegalName": "Some Legal Name",
  "TradingNameOrAlternativeBrandName": "Trading test file",
  "IndustryTypeId": null,
  "BusinessIdentifier": "53004085616",
  "BusinessIdentifierBranchNumber": null,
  "CompanyIdentifier": " 007249989",
  "PrimaryPhone": "0290125555",
  "Fax": null,
  "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,
    "SaleTradingTerms": {
      "TradingTermsType": 1,
      "TradingTermsInterval": 3,
      "TradingTermsIntervalType": 1
    },
    "PurchaseTradingTerms": {
      "TradingTermsType": 1,
      "TradingTermsInterval": 2,
      "TradingTermsIntervalType": 1
    },
    "_links": []
  },
  "IsTaxRegistered": false,
  "TaxRegistrationDate": null,
  "DateTimeFormatId": 0,
  "NumberFormatId": 0,
  "FinancialYearEndMonth": 0,
  "FinancialYearEndDate": 0,
  "PayrollYearEndMonth": 0,
  "PayrollYearEndDate": 0,
  "_links": []
}

application/xml, text/xml

Sample:
<FileIdentityDetail xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links />
  <CreatedDateUtc xsi:nil="true" />
  <LastModifiedDateUtc xsi:nil="true" />
  <LastModifiedByUserId xsi:nil="true" />
  <Name>Test File</Name>
  <FullLegalName>Some Legal Name</FullLegalName>
  <TradingNameOrAlternativeBrandName>Trading test file</TradingNameOrAlternativeBrandName>
  <IndustryTypeId xsi:nil="true" />
  <BusinessIdentifier>53004085616</BusinessIdentifier>
  <BusinessIdentifierBranchNumber xsi:nil="true" />
  <CompanyIdentifier> 007249989</CompanyIdentifier>
  <PrimaryPhone>0290125555</PrimaryPhone>
  <Fax xsi:nil="true" />
  <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>
    <SaleTradingTerms>
      <TradingTermsType>1</TradingTermsType>
      <TradingTermsInterval>3</TradingTermsInterval>
      <TradingTermsIntervalType>1</TradingTermsIntervalType>
    </SaleTradingTerms>
    <PurchaseTradingTerms>
      <TradingTermsType>1</TradingTermsType>
      <TradingTermsInterval>2</TradingTermsInterval>
      <TradingTermsIntervalType>1</TradingTermsIntervalType>
    </PurchaseTradingTerms>
  </FileSettings>
  <IsTaxRegistered>false</IsTaxRegistered>
  <TaxRegistrationDate xsi:nil="true" />
  <DateTimeFormatId>0</DateTimeFormatId>
  <NumberFormatId>0</NumberFormatId>
  <FinancialYearEndMonth>0</FinancialYearEndMonth>
  <FinancialYearEndDate>0</FinancialYearEndDate>
  <PayrollYearEndMonth>0</PayrollYearEndMonth>
  <PayrollYearEndDate>0</PayrollYearEndDate>
</FileIdentityDetail>

Response Information

Resource Description

UpdateFileIdentityDetailResult
Name Description Type Additional information
LastUpdatedId The unique identifier generated as part of the update. This value is required when submitting subsequent update to prevent concurrency errors. string

None.

UtcLastModified The date and time this resource was modified in UTC. date

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:
{
  "LastUpdatedId": "sample string 1",
  "UtcLastModified": "2023-06-03T05:13:29.0297218+10:00",
  "_links": [
    {
      "rel": "sample string 1",
      "href": "sample string 2",
      "method": "sample string 3",
      "title": "sample string 4"
    },
    {
      "rel": "sample string 1",
      "href": "sample string 2",
      "method": "sample string 3",
      "title": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:
<UpdateFileIdentityDetailResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links>
    <Link>
      <rel>sample string 1</rel>
      <href>sample string 2</href>
      <method>sample string 3</method>
      <title>sample string 4</title>
    </Link>
    <Link>
      <rel>sample string 1</rel>
      <href>sample string 2</href>
      <method>sample string 3</method>
      <title>sample string 4</title>
    </Link>
  </_links>
  <LastUpdatedId>sample string 1</LastUpdatedId>
  <UtcLastModified>2023-06-03T05:13:29.0297218+10:00</UtcLastModified>
</UpdateFileIdentityDetailResult>