GET Companies/{id}
Gets a company by it's ID, represented as CompanyDto.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The ID of the company. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
The company data.
CompanyDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| NetworkId | globally unique identifier |
None. |
|
| Code | string |
None. |
|
| Name | string |
None. |
|
| Street1 | string |
None. |
|
| Street2 | string |
None. |
|
| CountryId | globally unique identifier |
None. |
|
| CountryDescription | string |
None. |
|
| StateId | globally unique identifier |
None. |
|
| StateDescription | string |
None. |
|
| ZipCode | string |
None. |
|
| City | string |
None. |
|
| Street1Delivery | string |
None. |
|
| Street2Delivery | string |
None. |
|
| ZipCodeDelivery | string |
None. |
|
| CityDelivery | string |
None. |
|
| StateDelivery | string |
None. |
|
| CountryDelivery | string |
None. |
|
| IdStateDelivery | globally unique identifier |
None. |
|
| IdCountryDelivery | globally unique identifier |
None. |
|
| TaxPayerId | string |
None. |
|
| TaxpayerCategoryId | globally unique identifier |
None. |
|
| TaxpayerCategoryDescription | string |
None. |
|
| IndustryId | globally unique identifier |
None. |
|
| IndustryDescription | string |
None. |
|
| CreationDate | date |
None. |
|
| Type | byte |
None. |
|
| UpdateDate | date |
None. |
|
| ContactName | string |
None. |
|
| ContactEmail | string |
None. |
|
| ContactPhone1 | string |
None. |
|
| ContactPhone2 | string |
None. |
|
| Active | boolean |
None. |
|
| DesactivationType | byte |
None. |
|
| Plan | byte |
None. |
|
| CompaniesGroupId | globally unique identifier |
None. |
|
| PermissionsType | integer |
None. |
|
| IsCodeAutomaticallyGenerated | boolean |
None. |
|
| Custom0 | string |
None. |
|
| Custom1 | string |
None. |
|
| Custom2 | string |
None. |
|
| Custom3 | string |
None. |
|
| EnableCustom1 | boolean |
None. |
|
| EnableCustom2 | boolean |
None. |
|
| EnableCustom3 | boolean |
None. |
|
| EnableCustom4 | boolean |
None. |
|
| LabelCustom1 | string |
None. |
|
| LabelCustom2 | string |
None. |
|
| LabelCustom3 | string |
None. |
|
| LabelCustom4 | string |
None. |
|
| CompanyDocuments | Collection of CompanyDocumentDto |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "13ff324c-74f3-40ae-83d4-8b2907d8dc9c",
"NetworkId": "3ab1b240-ad45-4fd4-b9ec-66c66a268021",
"Code": "sample string 3",
"Name": "sample string 4",
"Street1": "sample string 5",
"Street2": "sample string 6",
"CountryId": "d38184a7-c833-4b8d-84da-9f35d8074c58",
"CountryDescription": "sample string 8",
"StateId": "6dd162f8-cd19-4660-9f6f-c128c987eb25",
"StateDescription": "sample string 10",
"ZipCode": "sample string 11",
"City": "sample string 12",
"Street1Delivery": "sample string 13",
"Street2Delivery": "sample string 14",
"ZipCodeDelivery": "sample string 15",
"CityDelivery": "sample string 16",
"StateDelivery": "sample string 17",
"CountryDelivery": "sample string 18",
"IdStateDelivery": "ac0fbab1-f12e-4713-aefd-3cd070eda25d",
"IdCountryDelivery": "f7f2f07b-6fc3-4082-8bed-693ffa52169e",
"TaxPayerId": "sample string 19",
"TaxpayerCategoryId": "5e3440c8-6ad3-401b-b30d-fa7ce356b7e6",
"TaxpayerCategoryDescription": "sample string 21",
"IndustryId": "500e7560-a944-4f6c-808a-d1dd81a73103",
"IndustryDescription": "sample string 23",
"CreationDate": "2026-08-11T01:42:38.4061557Z",
"Type": 64,
"UpdateDate": "2026-08-11T01:42:38.4061557Z",
"ContactName": "sample string 27",
"ContactEmail": "sample string 28",
"ContactPhone1": "sample string 29",
"ContactPhone2": "sample string 30",
"Active": true,
"DesactivationType": 64,
"Plan": 64,
"CompaniesGroupId": "08eaf625-f28b-4cac-8530-7b069b0f2d29",
"PermissionsType": 32,
"IsCodeAutomaticallyGenerated": true,
"Custom0": "sample string 34",
"Custom1": "sample string 35",
"Custom2": "sample string 36",
"Custom3": "sample string 37",
"EnableCustom1": true,
"EnableCustom2": true,
"EnableCustom3": true,
"EnableCustom4": true,
"LabelCustom1": "sample string 42",
"LabelCustom2": "sample string 43",
"LabelCustom3": "sample string 44",
"LabelCustom4": "sample string 45",
"CompanyDocuments": [
{
"Id": "c507da2b-15ed-4d45-9890-231bff363995",
"FileName": "sample string 2",
"FileFullUrl": "sample string 3",
"FileExtension": "sample string 4",
"FileContent": "QEA=",
"DocumentStatus": 0
},
{
"Id": "c507da2b-15ed-4d45-9890-231bff363995",
"FileName": "sample string 2",
"FileFullUrl": "sample string 3",
"FileExtension": "sample string 4",
"FileContent": "QEA=",
"DocumentStatus": 0
}
]
}
application/xml, text/xml
Sample:
<CompanyDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ationet.Model">
<Active>true</Active>
<City>sample string 12</City>
<CityDelivery>sample string 16</CityDelivery>
<Code>sample string 3</Code>
<CompaniesGroupId>08eaf625-f28b-4cac-8530-7b069b0f2d29</CompaniesGroupId>
<CompanyDocuments>
<CompanyDocumentDto>
<DocumentStatus>Add</DocumentStatus>
<FileContent>QEA=</FileContent>
<FileExtension>sample string 4</FileExtension>
<FileFullUrl>sample string 3</FileFullUrl>
<FileName>sample string 2</FileName>
<Id>c507da2b-15ed-4d45-9890-231bff363995</Id>
</CompanyDocumentDto>
<CompanyDocumentDto>
<DocumentStatus>Add</DocumentStatus>
<FileContent>QEA=</FileContent>
<FileExtension>sample string 4</FileExtension>
<FileFullUrl>sample string 3</FileFullUrl>
<FileName>sample string 2</FileName>
<Id>c507da2b-15ed-4d45-9890-231bff363995</Id>
</CompanyDocumentDto>
</CompanyDocuments>
<ContactEmail>sample string 28</ContactEmail>
<ContactName>sample string 27</ContactName>
<ContactPhone1>sample string 29</ContactPhone1>
<ContactPhone2>sample string 30</ContactPhone2>
<CountryDelivery>sample string 18</CountryDelivery>
<CountryDescription>sample string 8</CountryDescription>
<CountryId>d38184a7-c833-4b8d-84da-9f35d8074c58</CountryId>
<CreationDate>2026-08-11T01:42:38.4061557Z</CreationDate>
<Custom0>sample string 34</Custom0>
<Custom1>sample string 35</Custom1>
<Custom2>sample string 36</Custom2>
<Custom3>sample string 37</Custom3>
<DesactivationType>64</DesactivationType>
<EnableCustom1>true</EnableCustom1>
<EnableCustom2>true</EnableCustom2>
<EnableCustom3>true</EnableCustom3>
<EnableCustom4>true</EnableCustom4>
<Id>13ff324c-74f3-40ae-83d4-8b2907d8dc9c</Id>
<IdCountryDelivery>f7f2f07b-6fc3-4082-8bed-693ffa52169e</IdCountryDelivery>
<IdStateDelivery>ac0fbab1-f12e-4713-aefd-3cd070eda25d</IdStateDelivery>
<IndustryDescription>sample string 23</IndustryDescription>
<IndustryId>500e7560-a944-4f6c-808a-d1dd81a73103</IndustryId>
<IsCodeAutomaticallyGenerated>true</IsCodeAutomaticallyGenerated>
<LabelCustom1>sample string 42</LabelCustom1>
<LabelCustom2>sample string 43</LabelCustom2>
<LabelCustom3>sample string 44</LabelCustom3>
<LabelCustom4>sample string 45</LabelCustom4>
<Name>sample string 4</Name>
<NetworkId>3ab1b240-ad45-4fd4-b9ec-66c66a268021</NetworkId>
<PermissionsType>32</PermissionsType>
<Plan>64</Plan>
<StateDelivery>sample string 17</StateDelivery>
<StateDescription>sample string 10</StateDescription>
<StateId>6dd162f8-cd19-4660-9f6f-c128c987eb25</StateId>
<Street1>sample string 5</Street1>
<Street1Delivery>sample string 13</Street1Delivery>
<Street2>sample string 6</Street2>
<Street2Delivery>sample string 14</Street2Delivery>
<TaxPayerId>sample string 19</TaxPayerId>
<TaxpayerCategoryDescription>sample string 21</TaxpayerCategoryDescription>
<TaxpayerCategoryId>5e3440c8-6ad3-401b-b30d-fa7ce356b7e6</TaxpayerCategoryId>
<Type>64</Type>
<UpdateDate>2026-08-11T01:42:38.4061557Z</UpdateDate>
<ZipCode>sample string 11</ZipCode>
<ZipCodeDelivery>sample string 15</ZipCodeDelivery>
</CompanyDto>