POST api/company/{companyID}

Update a company

Request Information

URI Parameters

Name	Description	Type	Additional information
companyID	Unique company identifier	integer	Required

Body Parameters

New values of company attributes

CompanyUpdate

Name	Description	Type	Additional information
Email	Email Address of company	string	String length: inclusive between 0 and 255
CompanyName	Name of company	string	String length: inclusive between 0 and 100
TFN	Tax file number	string	String length: inclusive between 0 and 24
TFNExemptionType	Tax Exemption code	enTaxExemptionCode	None.
ABN	Australian business number	string	String length: inclusive between 0 and 14
ExternalRef	External reference	string	String length: inclusive between 0 and 100

Request Formats

application/json, text/json

Sample:

{
  "Email": "test@test.com",
  "CompanyName": "Company A",
  "TFN": "987654321",
  "TFNExemptionType": 1,
  "ABN": "123456789",
  "ExternalRef": "TestCompanyA"
}

application/xml, text/xml

Sample:

<CompanyUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:x="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Company">
  <Email i:type="x:string" xmlns="">test@test.com</Email>
  <CompanyName i:type="x:string" xmlns="">Company A</CompanyName>
  <TFN i:type="x:string" xmlns="">987654321</TFN>
  <TFNExemptionType xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.Utilities" i:type="d2p1:enTaxExemptionCode" xmlns="">tfnExempt00000000000</TFNExemptionType>
  <ABN i:type="x:string" xmlns="">123456789</ABN>
  <ExternalRef i:type="x:string" xmlns="">TestCompanyA</ExternalRef>
</CompanyUpdate>

Response Information

Resource Description

CompanyUpdateResult

Name	Description	Type	Additional information
CompanyID	An identifier of updated company	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "CompanyID": 100500
}

application/xml, text/xml

Sample:

<CompanyUpdateResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Company">
  <CompanyID>100500</CompanyID>
</CompanyUpdateResult>

Error Response Information

Resource Description

BadRequestResult

Name	Description	Type	Additional information
Errors		Collection of Error	None.

Error Response Formats

application/json, text/json

Sample:

{
  "Errors": [
    {
      "Code": 10035,
      "Description": "sample string 1"
    },
    {
      "Code": 10035,
      "Description": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<BadRequestResultOfenCompanyUpdateErrorYd1IcMMv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.ErrorResponse">
  <Errors>
    <ErrorOfenCompanyUpdateErrorYd1IcMMv>
      <Code>CompanyName</Code>
      <Description>sample string 1</Description>
    </ErrorOfenCompanyUpdateErrorYd1IcMMv>
    <ErrorOfenCompanyUpdateErrorYd1IcMMv>
      <Code>CompanyName</Code>
      <Description>sample string 1</Description>
    </ErrorOfenCompanyUpdateErrorYd1IcMMv>
  </Errors>
</BadRequestResultOfenCompanyUpdateErrorYd1IcMMv>