POST api/company

Create new company

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
BrandID	Brand ID of new company	integer	Required
CompanyName	Name of the new company	string	Required String length: inclusive between 0 and 100
TFN	Tax file number	string	String length: inclusive between 0 and 24
ABN	Australian business number. Unless agreed with TPP, this field is required for company creation	string	String length: inclusive between 0 and 14
ACN	Australian company number. Unless agreed with TPP, this field is required for company creation	string	String length: inclusive between 0 and 11
RegisteredAddress	Registered address of business. Used as destination for posted contract / statements, in condition where postal address is not specified. Unless agreed with TPP, this field is required for company creation	Address	None.
PostalAddress	Postal address of business. Used as destination for posted contract / statements. If not specified, registered address will be used. Unless agreed with TPP, this field is required for company creation	Address	None.
ExternalRef	External reference. An identifier of company record in front office systems. Unique by brand if value provided.	string	String length: inclusive between 0 and 100
Email	Email. Company email address	string	String length: inclusive between 0 and 255
TFNExemptionType	Tax File Number exemption type (optional)	enTaxExemptionCode	None.

Request Formats

application/json, text/json

Sample:

{
  "BrandID": 1,
  "CompanyName": "CLEARING PTE LTD",
  "TFN": "862793498",
  "ABN": "50673789893",
  "ACN": "120964034",
  "RegisteredAddress": {
    "Address1": "CLEARING PTE LTD,",
    "Address2": "LEVEL 20",
    "Address3": "GOVERNOR PHILIP TOWER",
    "Address4": "1 FARRER PLACE",
    "Suburb": "SYDNEY",
    "State": "NSW",
    "Postcode": "2000",
    "Country": "AUSTRALIA"
  },
  "PostalAddress": {
    "Address1": "CLEARING PTE LTD,",
    "Address2": "LEVEL 20",
    "Address3": "GOVERNOR PHILIP TOWER",
    "Address4": "1 FARRER PLACE",
    "Suburb": "SYDNEY",
    "State": "NSW",
    "Postcode": "2000",
    "Country": "AUSTRALIA"
  },
  "ExternalRef": "1300290",
  "Email": "test@test.com",
  "TFNExemptionType": 1
}

application/xml, text/xml

Sample:

<CompanyCreation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Company">
  <ABN>50673789893</ABN>
  <ACN>120964034</ACN>
  <BrandID>1</BrandID>
  <CompanyName>CLEARING PTE LTD</CompanyName>
  <Email>test@test.com</Email>
  <ExternalRef>1300290</ExternalRef>
  <PostalAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account">
    <d2p1:Address1>CLEARING PTE LTD,</d2p1:Address1>
    <d2p1:Address2>LEVEL 20</d2p1:Address2>
    <d2p1:Address3>GOVERNOR PHILIP TOWER</d2p1:Address3>
    <d2p1:Address4>1 FARRER PLACE</d2p1:Address4>
    <d2p1:Country>AUSTRALIA</d2p1:Country>
    <d2p1:Postcode>2000</d2p1:Postcode>
    <d2p1:State>NSW</d2p1:State>
    <d2p1:Suburb>SYDNEY</d2p1:Suburb>
  </PostalAddress>
  <RegisteredAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account">
    <d2p1:Address1>CLEARING PTE LTD,</d2p1:Address1>
    <d2p1:Address2>LEVEL 20</d2p1:Address2>
    <d2p1:Address3>GOVERNOR PHILIP TOWER</d2p1:Address3>
    <d2p1:Address4>1 FARRER PLACE</d2p1:Address4>
    <d2p1:Country>AUSTRALIA</d2p1:Country>
    <d2p1:Postcode>2000</d2p1:Postcode>
    <d2p1:State>NSW</d2p1:State>
    <d2p1:Suburb>SYDNEY</d2p1:Suburb>
  </RegisteredAddress>
  <TFN>862793498</TFN>
  <TFNExemptionType>tfnExempt00000000000</TFNExemptionType>
</CompanyCreation>

Response Information

Resource Description

CompanyCreationResult

Name	Description	Type	Additional information
CompanyID	Company ID created	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "CompanyID": 41173
}

application/xml, text/xml

Sample:

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

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": 10000,
      "Description": "sample string 1"
    },
    {
      "Code": 10000,
      "Description": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

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