GET api/companies?skip={skip}&take={take}&name={name}
Get all companies
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| skip | integer |
Default value is 0 |
|
| take | integer |
Default value is 100 |
|
| name | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of CompanyRequestDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId |
CompanyId |
integer |
None. |
| Name |
Name |
string |
None. |
| AccountingOfficeId |
AccountingOfficeId |
integer |
None. |
| VAT |
VAT |
string |
None. |
| Status |
Status |
integer |
None. |
| DefaultCurrencyCode |
DefaultCurrencyCode |
string |
None. |
| InboundFilesEmail |
InboundFilesEmail |
string |
None. |
| IBAN |
IBAN |
string |
None. |
| AdditionalInfo |
AdditionalInfo |
string |
None. |
| IsVatRegistered |
IsVatRegistered |
boolean |
None. |
| DataImportStatus |
DataImportStatus |
boolean |
None. |
| LastCompanyLevelChange |
LastCompanyLevelChange |
date |
None. |
| LastSuccessfulPayment |
LastSuccessfulPayment |
date |
None. |
| CompanyAddress |
CompanyAddress |
CompanyAddressRequestDTO |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"CompanyId": 1,
"Name": "sample string 2",
"AccountingOfficeId": 3,
"VAT": "sample string 4",
"Status": 5,
"DefaultCurrencyCode": "sample string 6",
"InboundFilesEmail": "sample string 7",
"IBAN": "sample string 8",
"AdditionalInfo": "sample string 9",
"IsVatRegistered": true,
"DataImportStatus": true,
"LastCompanyLevelChange": "2026-11-22T14:10:30.0548808+00:00",
"LastSuccessfulPayment": "2026-11-22T14:10:30.0548808+00:00",
"CompanyAddress": {
"StreetAddress": "sample string 1",
"PostCode": "sample string 2",
"City": "sample string 3",
"CountryId": 4,
"CountryName": "sample string 5"
}
},
{
"CompanyId": 1,
"Name": "sample string 2",
"AccountingOfficeId": 3,
"VAT": "sample string 4",
"Status": 5,
"DefaultCurrencyCode": "sample string 6",
"InboundFilesEmail": "sample string 7",
"IBAN": "sample string 8",
"AdditionalInfo": "sample string 9",
"IsVatRegistered": true,
"DataImportStatus": true,
"LastCompanyLevelChange": "2026-11-22T14:10:30.0548808+00:00",
"LastSuccessfulPayment": "2026-11-22T14:10:30.0548808+00:00",
"CompanyAddress": {
"StreetAddress": "sample string 1",
"PostCode": "sample string 2",
"City": "sample string 3",
"CountryId": 4,
"CountryName": "sample string 5"
}
}
]
text/html
Sample:
[{"CompanyId":1,"Name":"sample string 2","AccountingOfficeId":3,"VAT":"sample string 4","Status":5,"DefaultCurrencyCode":"sample string 6","InboundFilesEmail":"sample string 7","IBAN":"sample string 8","AdditionalInfo":"sample string 9","IsVatRegistered":true,"DataImportStatus":true,"LastCompanyLevelChange":"2026-11-22T14:10:30.0548808+00:00","LastSuccessfulPayment":"2026-11-22T14:10:30.0548808+00:00","CompanyAddress":{"StreetAddress":"sample string 1","PostCode":"sample string 2","City":"sample string 3","CountryId":4,"CountryName":"sample string 5"}},{"CompanyId":1,"Name":"sample string 2","AccountingOfficeId":3,"VAT":"sample string 4","Status":5,"DefaultCurrencyCode":"sample string 6","InboundFilesEmail":"sample string 7","IBAN":"sample string 8","AdditionalInfo":"sample string 9","IsVatRegistered":true,"DataImportStatus":true,"LastCompanyLevelChange":"2026-11-22T14:10:30.0548808+00:00","LastSuccessfulPayment":"2026-11-22T14:10:30.0548808+00:00","CompanyAddress":{"StreetAddress":"sample string 1","PostCode":"sample string 2","City":"sample string 3","CountryId":4,"CountryName":"sample string 5"}}]
application/xml, text/xml
Sample:
<ArrayOfCompanyRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs">
<CompanyRequestDTO>
<AccountingOfficeId>3</AccountingOfficeId>
<AdditionalInfo>sample string 9</AdditionalInfo>
<CompanyAddress>
<City>sample string 3</City>
<CountryId>4</CountryId>
<CountryName>sample string 5</CountryName>
<PostCode>sample string 2</PostCode>
<StreetAddress>sample string 1</StreetAddress>
</CompanyAddress>
<CompanyId>1</CompanyId>
<DataImportStatus>true</DataImportStatus>
<DefaultCurrencyCode>sample string 6</DefaultCurrencyCode>
<IBAN>sample string 8</IBAN>
<InboundFilesEmail>sample string 7</InboundFilesEmail>
<IsVatRegistered>true</IsVatRegistered>
<LastCompanyLevelChange>2026-11-22T14:10:30.0548808+00:00</LastCompanyLevelChange>
<LastSuccessfulPayment>2026-11-22T14:10:30.0548808+00:00</LastSuccessfulPayment>
<Name>sample string 2</Name>
<Status>5</Status>
<VAT>sample string 4</VAT>
</CompanyRequestDTO>
<CompanyRequestDTO>
<AccountingOfficeId>3</AccountingOfficeId>
<AdditionalInfo>sample string 9</AdditionalInfo>
<CompanyAddress>
<City>sample string 3</City>
<CountryId>4</CountryId>
<CountryName>sample string 5</CountryName>
<PostCode>sample string 2</PostCode>
<StreetAddress>sample string 1</StreetAddress>
</CompanyAddress>
<CompanyId>1</CompanyId>
<DataImportStatus>true</DataImportStatus>
<DefaultCurrencyCode>sample string 6</DefaultCurrencyCode>
<IBAN>sample string 8</IBAN>
<InboundFilesEmail>sample string 7</InboundFilesEmail>
<IsVatRegistered>true</IsVatRegistered>
<LastCompanyLevelChange>2026-11-22T14:10:30.0548808+00:00</LastCompanyLevelChange>
<LastSuccessfulPayment>2026-11-22T14:10:30.0548808+00:00</LastSuccessfulPayment>
<Name>sample string 2</Name>
<Status>5</Status>
<VAT>sample string 4</VAT>
</CompanyRequestDTO>
</ArrayOfCompanyRequestDTO>