Billhighway Cloud API

<back to all web services

Company

The following routes are available for this service:
POST/company
Company Parameters:
NameParameterData TypeRequiredDescription
UniqueIdbodystringNo
CreatedDateTimebodyDateTimeNo
ClientIdbodyintNo
GroupIdbodystringNo
CompanyIdbodyintNo
ExternalCompanyIdbodystringNo
CompanyNamebodystringNo
Address1bodystringNo
Address2bodystringNo
CitybodystringNo
StatebodystringNo
ZipCodebodystringNo
CountrybodystringNo
WebsitebodystringNo
PhoneNumberbodystringNo
FaxbodystringNo
StateIdbodyintNo
CountryIdbodyintNo
ChapIdbodyintNo
CompanyReply Parameters:
NameParameterData TypeRequiredDescription
UniqueIdformstringNo
CompanyIdformintNo
ReplyBase Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformintNo
ErrorMessageformstringNo
IsErrorformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /company HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Company xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <Address1>String</Address1>
  <Address2>String</Address2>
  <ChapId>0</ChapId>
  <City>String</City>
  <ClientId>0</ClientId>
  <CompanyId>0</CompanyId>
  <CompanyName>String</CompanyName>
  <Country>String</Country>
  <CountryId>0</CountryId>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <ExternalCompanyId>String</ExternalCompanyId>
  <Fax>String</Fax>
  <GroupId>String</GroupId>
  <PhoneNumber>String</PhoneNumber>
  <State>String</State>
  <StateId>0</StateId>
  <UniqueId>String</UniqueId>
  <Website>String</Website>
  <ZipCode>String</ZipCode>
</Company>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanyReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</ErrorCode>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</ErrorMessage>
  <CompanyId>0</CompanyId>
  <UniqueId>String</UniqueId>
</CompanyReply>