GET api/Companies/GetCompanies
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Company| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId | integer |
None. |
|
| CompanyName | string |
String length: inclusive between 0 and 100 |
|
| CompanyDisplayName | string |
String length: inclusive between 0 and 100 |
|
| CompanyStreet | string |
String length: inclusive between 0 and 100 |
|
| CompanyPCode | string |
String length: inclusive between 0 and 20 |
|
| CompanyCity | string |
String length: inclusive between 0 and 100 |
|
| CompanyDepartment | Department |
None. |
|
| CountryId | integer |
None. |
|
| Country | Country |
None. |
|
| CompanyTelephone1 | string |
String length: inclusive between 0 and 35 |
|
| CompanyTelephone2 | string |
String length: inclusive between 0 and 35 |
|
| CompanyMobile1 | string |
String length: inclusive between 0 and 35 |
|
| CompanyTelefax | string |
String length: inclusive between 0 and 35 |
|
| CompanyEmailGeneral | string |
String length: inclusive between 0 and 100 |
|
| CompanyCompanyNumber | string |
String length: inclusive between 0 and 35 |
|
| CompanyDateCreated | date |
None. |
|
| CompanyUserIdCreated | string |
None. |
|
| CompanyDateChanged | date |
None. |
|
| CompanyUserIdChanged | string |
None. |
|
| CompanyIban1 | string |
String length: inclusive between 0 and 35 |
|
| CompanyIban2 | string |
String length: inclusive between 0 and 35 |
|
| InvoiceEmailTemplateId | integer |
None. |
|
| InvoiceEmailTemplate | EmarketingTemplate |
None. |
|
| SalesQuoteEmailTemplateId | integer |
None. |
|
| SalesQuoteEmailTemplate | EmarketingTemplate |
None. |
|
| SalesOrderEmailTemplateId | integer |
None. |
|
| SalesOrderEmailTemplate | EmarketingTemplate |
None. |
|
| SalesDeliveryEmailTemplateId | integer |
None. |
|
| SalesDeliveryEmailTemplate | EmarketingTemplate |
None. |
|
| CompanyRPR | string |
String length: inclusive between 0 and 35 |
|
| NextSalesQuoteNr | integer |
None. |
|
| NextSalesOrderNr | integer |
None. |
|
| NextSalesDeliveryNr | integer |
None. |
|
| NextSalesInvoiceNr | integer |
None. |
|
| BookYear | integer |
None. |
|
| InvoiceMailaddress | string |
None. |
|
| UBLMailAddress | string |
None. |
|
| NextCustomerNumber | integer |
None. |
|
| ObjectState | ObjectState |
None. |
Response Formats
application/json, text/json
Sample:
{
"companyId": 1,
"companyName": "sample string 2",
"companyDisplayName": "sample string 3",
"companyStreet": "sample string 4",
"companyPCode": "sample string 5",
"companyCity": "sample string 6",
"companyDepartment": 0,
"countryId": 1,
"country": {
"countryId": 1,
"countryName": "sample string 2",
"countryIsocode": "sample string 3",
"defaultLanguageId": 4,
"telephoneCountryPrefix": "sample string 5",
"objectState": 0
},
"companyTelephone1": "sample string 7",
"companyTelephone2": "sample string 8",
"companyMobile1": "sample string 9",
"companyTelefax": "sample string 10",
"companyEmailGeneral": "sample string 11",
"companyCompanyNumber": "sample string 12",
"companyDateCreated": "2026-09-29T08:56:26.9716061+00:00",
"companyUserIdCreated": "sample string 13",
"companyDateChanged": "2026-09-29T08:56:26.9716061+00:00",
"companyUserIdChanged": "sample string 14",
"companyIban1": "sample string 15",
"companyIban2": "sample string 16",
"invoiceEmailTemplateId": 17,
"invoiceEmailTemplate": {
"emarketingTemplateId": 1,
"emarketingTemplateDescription": "sample string 2",
"emarketingTemplateContent": "sample string 3",
"companyId": 4,
"mailfrom": "sample string 5",
"mailfromName": "sample string 6",
"mailSubject": "sample string 7",
"templateType": 8,
"objectState": 0
},
"salesQuoteEmailTemplateId": 18,
"salesQuoteEmailTemplate": {
"emarketingTemplateId": 1,
"emarketingTemplateDescription": "sample string 2",
"emarketingTemplateContent": "sample string 3",
"companyId": 4,
"mailfrom": "sample string 5",
"mailfromName": "sample string 6",
"mailSubject": "sample string 7",
"templateType": 8,
"objectState": 0
},
"salesOrderEmailTemplateId": 19,
"salesOrderEmailTemplate": {
"emarketingTemplateId": 1,
"emarketingTemplateDescription": "sample string 2",
"emarketingTemplateContent": "sample string 3",
"companyId": 4,
"mailfrom": "sample string 5",
"mailfromName": "sample string 6",
"mailSubject": "sample string 7",
"templateType": 8,
"objectState": 0
},
"salesDeliveryEmailTemplateId": 20,
"salesDeliveryEmailTemplate": {
"emarketingTemplateId": 1,
"emarketingTemplateDescription": "sample string 2",
"emarketingTemplateContent": "sample string 3",
"companyId": 4,
"mailfrom": "sample string 5",
"mailfromName": "sample string 6",
"mailSubject": "sample string 7",
"templateType": 8,
"objectState": 0
},
"companyRPR": "sample string 21",
"nextSalesQuoteNr": 22,
"nextSalesOrderNr": 23,
"nextSalesDeliveryNr": 24,
"nextSalesInvoiceNr": 25,
"bookYear": 26,
"invoiceMailaddress": "sample string 27",
"ublMailAddress": "sample string 28",
"nextCustomerNumber": 29,
"objectState": 0
}
application/xml, text/xml
Sample:
<Company xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gruo.Core.Models">
<ObjectState xmlns="http://schemas.datacontract.org/2004/07/Gruo.Core.Repository">Unchanged</ObjectState>
<BookYear>26</BookYear>
<CompanyCity>sample string 6</CompanyCity>
<CompanyCompanyNumber>sample string 12</CompanyCompanyNumber>
<CompanyDateChanged>2026-09-29T08:56:26.9716061+00:00</CompanyDateChanged>
<CompanyDateCreated>2026-09-29T08:56:26.9716061+00:00</CompanyDateCreated>
<CompanyDepartment>Empty</CompanyDepartment>
<CompanyDisplayName>sample string 3</CompanyDisplayName>
<CompanyEmailGeneral>sample string 11</CompanyEmailGeneral>
<CompanyIban1>sample string 15</CompanyIban1>
<CompanyIban2>sample string 16</CompanyIban2>
<CompanyId>1</CompanyId>
<CompanyMobile1>sample string 9</CompanyMobile1>
<CompanyName>sample string 2</CompanyName>
<CompanyPCode>sample string 5</CompanyPCode>
<CompanyRPR>sample string 21</CompanyRPR>
<CompanyStreet>sample string 4</CompanyStreet>
<CompanyTelefax>sample string 10</CompanyTelefax>
<CompanyTelephone1>sample string 7</CompanyTelephone1>
<CompanyTelephone2>sample string 8</CompanyTelephone2>
<CompanyUserIdChanged>sample string 14</CompanyUserIdChanged>
<CompanyUserIdCreated>sample string 13</CompanyUserIdCreated>
<Country>
<ObjectState xmlns="http://schemas.datacontract.org/2004/07/Gruo.Core.Repository">Unchanged</ObjectState>
<CountryId>1</CountryId>
<CountryIsocode>sample string 3</CountryIsocode>
<CountryName>sample string 2</CountryName>
<DefaultLanguageId>4</DefaultLanguageId>
<TelephoneCountryPrefix>sample string 5</TelephoneCountryPrefix>
</Country>
<CountryId>1</CountryId>
<InvoiceEmailTemplate>
<ObjectState xmlns="http://schemas.datacontract.org/2004/07/Gruo.Core.Repository">Unchanged</ObjectState>
<CompanyId>4</CompanyId>
<EmarketingTemplateContent>sample string 3</EmarketingTemplateContent>
<EmarketingTemplateDescription>sample string 2</EmarketingTemplateDescription>
<EmarketingTemplateId>1</EmarketingTemplateId>
<MailSubject>sample string 7</MailSubject>
<Mailfrom>sample string 5</Mailfrom>
<MailfromName>sample string 6</MailfromName>
<TemplateType>8</TemplateType>
</InvoiceEmailTemplate>
<InvoiceEmailTemplateId>17</InvoiceEmailTemplateId>
<InvoiceMailaddress>sample string 27</InvoiceMailaddress>
<NextCustomerNumber>29</NextCustomerNumber>
<NextSalesDeliveryNr>24</NextSalesDeliveryNr>
<NextSalesInvoiceNr>25</NextSalesInvoiceNr>
<NextSalesOrderNr>23</NextSalesOrderNr>
<NextSalesQuoteNr>22</NextSalesQuoteNr>
<SalesDeliveryEmailTemplate>
<ObjectState xmlns="http://schemas.datacontract.org/2004/07/Gruo.Core.Repository">Unchanged</ObjectState>
<CompanyId>4</CompanyId>
<EmarketingTemplateContent>sample string 3</EmarketingTemplateContent>
<EmarketingTemplateDescription>sample string 2</EmarketingTemplateDescription>
<EmarketingTemplateId>1</EmarketingTemplateId>
<MailSubject>sample string 7</MailSubject>
<Mailfrom>sample string 5</Mailfrom>
<MailfromName>sample string 6</MailfromName>
<TemplateType>8</TemplateType>
</SalesDeliveryEmailTemplate>
<SalesDeliveryEmailTemplateId>20</SalesDeliveryEmailTemplateId>
<SalesOrderEmailTemplate>
<ObjectState xmlns="http://schemas.datacontract.org/2004/07/Gruo.Core.Repository">Unchanged</ObjectState>
<CompanyId>4</CompanyId>
<EmarketingTemplateContent>sample string 3</EmarketingTemplateContent>
<EmarketingTemplateDescription>sample string 2</EmarketingTemplateDescription>
<EmarketingTemplateId>1</EmarketingTemplateId>
<MailSubject>sample string 7</MailSubject>
<Mailfrom>sample string 5</Mailfrom>
<MailfromName>sample string 6</MailfromName>
<TemplateType>8</TemplateType>
</SalesOrderEmailTemplate>
<SalesOrderEmailTemplateId>19</SalesOrderEmailTemplateId>
<SalesQuoteEmailTemplate>
<ObjectState xmlns="http://schemas.datacontract.org/2004/07/Gruo.Core.Repository">Unchanged</ObjectState>
<CompanyId>4</CompanyId>
<EmarketingTemplateContent>sample string 3</EmarketingTemplateContent>
<EmarketingTemplateDescription>sample string 2</EmarketingTemplateDescription>
<EmarketingTemplateId>1</EmarketingTemplateId>
<MailSubject>sample string 7</MailSubject>
<Mailfrom>sample string 5</Mailfrom>
<MailfromName>sample string 6</MailfromName>
<TemplateType>8</TemplateType>
</SalesQuoteEmailTemplate>
<SalesQuoteEmailTemplateId>18</SalesQuoteEmailTemplateId>
<UBLMailAddress>sample string 28</UBLMailAddress>
</Company>