GET api/Company
Get basic company information.
Request Information
URI Parameters
None.
Body Parameters
None.
Remarks
None.
Example
None.
Response Information
Resource Description
CompanyResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Company Id |
globally unique identifier |
None. |
| Name |
Name of company |
string |
Max length: 80 |
| OrgNo |
Company registration number |
string |
Max length: 20 |
| Address1 |
Company adress |
string |
Max length: 100 |
| Address2 |
Company adress |
string |
Max length: 100 |
| Address3 |
Company adress |
string |
Max length: 100 |
| PostalCode |
Company Postal code |
string |
Max length: 10 |
| Town |
Company Town |
string |
Max length: 50 |
| BoardHome |
Company Board home |
string |
Max length: 50 |
| CountryId |
ISO 3166 Alpha-2 country id of the company. |
string |
Max length: 2 |
| Phone1 |
Company phone number |
string |
Max length: 50 |
| Phone2 |
Company phone number |
string |
Max length: 50 |
| Fax |
Company fax number |
string |
Max length: 50 |
| WebSite |
Company web site |
string |
Max length: 100 |
|
Company email |
string |
Max length: 50 |
|
| VatNo |
Company VAT registration number |
string |
Max length: 30 |
| HasCorporationTax |
Indicates if the company is VAT registered. |
boolean |
None. |
Response Formats
application/json, text/json
{
"Id": "10beca64-f9c3-476d-84ff-529975e17291",
"Name": "sample string 2",
"OrgNo": "sample string 3",
"Address1": "sample string 4",
"Address2": "sample string 5",
"Address3": "sample string 6",
"PostalCode": "sample string 7",
"Town": "sample string 8",
"BoardHome": "sample string 9",
"CountryId": "sample string 10",
"Phone1": "sample string 11",
"Phone2": "sample string 12",
"Fax": "sample string 13",
"WebSite": "sample string 14",
"Email": "sample string 15",
"VatNo": "sample string 16",
"HasCorporationTax": true
}
application/xml, text/xml
<CompanyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Business"> <Address1>sample string 4</Address1> <Address2>sample string 5</Address2> <Address3>sample string 6</Address3> <BoardHome>sample string 9</BoardHome> <CountryId>sample string 10</CountryId> <Email>sample string 15</Email> <Fax>sample string 13</Fax> <HasCorporationTax>true</HasCorporationTax> <Id>10beca64-f9c3-476d-84ff-529975e17291</Id> <Name>sample string 2</Name> <OrgNo>sample string 3</OrgNo> <Phone1>sample string 11</Phone1> <Phone2>sample string 12</Phone2> <PostalCode>sample string 7</PostalCode> <Town>sample string 8</Town> <VatNo>sample string 16</VatNo> <WebSite>sample string 14</WebSite> </CompanyResponse>