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.
CompanyDtoName | 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": "69a56888-80ff-4bf0-a3f3-31973432b525", "NetworkId": "75a48e37-7303-4b12-a959-c2a7f1dd7999", "Code": "sample string 3", "Name": "sample string 4", "Street1": "sample string 5", "Street2": "sample string 6", "CountryId": "eaca5326-5cc6-4de4-80dd-55ffb00a67d6", "CountryDescription": "sample string 8", "StateId": "68c29c19-fcb4-459d-b9ff-757bd7539076", "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": "e3dbfe19-27cc-41f1-8394-c9dc758a6a0b", "IdCountryDelivery": "f20a3340-2526-4444-9cca-fc4119b73722", "TaxPayerId": "sample string 19", "TaxpayerCategoryId": "555271fd-65e7-45b8-b328-9c7e00ff864e", "TaxpayerCategoryDescription": "sample string 21", "IndustryId": "8e66b5f5-f3e3-45be-863e-b470f13d56ff", "IndustryDescription": "sample string 23", "CreationDate": "2025-09-18T00:48:32.4224276Z", "Type": 64, "UpdateDate": "2025-09-18T00:48:32.4224276Z", "ContactName": "sample string 27", "ContactEmail": "sample string 28", "ContactPhone1": "sample string 29", "ContactPhone2": "sample string 30", "Active": true, "DesactivationType": 64, "Plan": 64, "CompaniesGroupId": "dcfacb45-f8ac-4838-9aca-36f64dc4a908", "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": "55578bb3-f1e0-4a9a-a062-6c7ef79d524f", "FileName": "sample string 2", "FileFullUrl": "sample string 3", "FileExtension": "sample string 4", "FileContent": "QEA=", "DocumentStatus": 0 }, { "Id": "55578bb3-f1e0-4a9a-a062-6c7ef79d524f", "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>dcfacb45-f8ac-4838-9aca-36f64dc4a908</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>55578bb3-f1e0-4a9a-a062-6c7ef79d524f</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>55578bb3-f1e0-4a9a-a062-6c7ef79d524f</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>eaca5326-5cc6-4de4-80dd-55ffb00a67d6</CountryId> <CreationDate>2025-09-18T00:48:32.4224276Z</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>69a56888-80ff-4bf0-a3f3-31973432b525</Id> <IdCountryDelivery>f20a3340-2526-4444-9cca-fc4119b73722</IdCountryDelivery> <IdStateDelivery>e3dbfe19-27cc-41f1-8394-c9dc758a6a0b</IdStateDelivery> <IndustryDescription>sample string 23</IndustryDescription> <IndustryId>8e66b5f5-f3e3-45be-863e-b470f13d56ff</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>75a48e37-7303-4b12-a959-c2a7f1dd7999</NetworkId> <PermissionsType>32</PermissionsType> <Plan>64</Plan> <StateDelivery>sample string 17</StateDelivery> <StateDescription>sample string 10</StateDescription> <StateId>68c29c19-fcb4-459d-b9ff-757bd7539076</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>555271fd-65e7-45b8-b328-9c7e00ff864e</TaxpayerCategoryId> <Type>64</Type> <UpdateDate>2025-09-18T00:48:32.4224276Z</UpdateDate> <ZipCode>sample string 11</ZipCode> <ZipCodeDelivery>sample string 15</ZipCodeDelivery> </CompanyDto>