Retrieves all the locations
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
location| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
|
| _parent_id |
Reference to a parent location |
globally unique identifier | |
| _parent_reference_back_office |
Embedded entity "location" for parent location using ERP PK when adding/updating location |
string | |
| _parent_location |
Embedded entity "location" for parent location when adding/updating location |
location | |
| project_status_id |
Foreign key to project_status_id |
globally unique identifier | |
| company_id |
The company owner of this location |
globally unique identifier |
Optionally required : company_id, company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating location |
string |
Optionally required : company_id, company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating location |
company |
Optionally required : company_id, company_code or company must be provided |
| name |
Name of the location |
string |
Required Max length: 50 |
| extra_information |
extra_information |
string |
Max length: 255 |
| reference_back_office |
The Id/Ref of the back office for this location. Used by Embedded entity |
string |
Max length: 255 |
| street |
Street |
string |
Max length: 100 |
| street_number |
Street number. |
string |
Max length: 50 |
| zip |
Zip code |
string |
Max length: 50 |
| city |
City |
string |
Max length: 50 |
| phone |
Phone number |
string |
Max length: 50 |
|
Email address |
string |
Max length: 250 |
|
| db_country_id |
Foreign key to table Country |
globally unique identifier | |
| db_country_code |
CountryCode entity using international code when adding/updating company |
string | |
| street2 |
Additional information on the address not part of the postal address |
string |
Max length: 50 |
| latitude_decimal |
Decimal coordonate for the latitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
| longitude_decimal |
Decimal coordonate for the longitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
| contact_id |
Foreign key of contact for this location |
globally unique identifier | |
| contact_reference_back_office |
Foreign key of contact for this location. If you don't know the GUID, use contact_reference_back_office |
string | |
| contact |
Embedded entity "contact" when adding/updating location |
contact | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| id2 |
Internal ID (numeric). Will be used if reference_back_office is empty |
integer |
Response Formats
application/json, text/json
Sample:
{
"id": "d8273c5c-8f25-45db-bf6d-d9f46b768cdb",
"_parent_id": "d22dd35b-640e-419a-95d0-5697259ae8ef",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "43e3bf0a-09a8-4fa2-8134-1d65c06a9087",
"company_id": "14c113f1-eabf-4406-b97b-afcf5f8508b8",
"company_code": "sample string 6",
"name": "sample string 7",
"extra_information": "sample string 8",
"reference_back_office": "sample string 9",
"street": "sample string 10",
"street_number": "sample string 11",
"zip": "sample string 12",
"city": "sample string 13",
"phone": "sample string 14",
"email": "sample string 15",
"db_country_id": "c5b59ccc-a206-4904-9724-058a612b73b9",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "14bc27d1-dfde-425d-bcc1-c1ca65c6d876",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c6439492-e44e-42c2-91d2-88f5c103c468",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "638508a2-649d-4567-8b40-22265e005c39",
"company_code": "sample string 5",
"company": {
"id": "20e1c42c-f551-4061-8beb-54702d2bc013",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-29T02:59:36.7075896+00:00",
"sales_territory_id": "8015c35a-cd25-4fa8-80ae-5b7d6a007857",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "95c5dada-3b2c-4111-90d7-9ace3ebdc5d4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "53b5a08a-5bdb-462e-8a2c-0bca00e4d23d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "685f5046-4a2c-4d15-ba2b-e84814ef9380",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "262b020e-41f1-4e6c-aea5-fe8e15b6ad15",
"db_currency_id": "6bfe262d-7576-4fac-82df-afef1eef0a0d",
"db_language_id": "25831335-611d-45c1-821c-c7328e120cfe",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-29T02:59:36.7075896+00:00"
},
"modified_dateutc": "2026-08-29T02:59:36.7075896+00:00"
},
"marketing_segment_id": "3c392ba2-5dfa-438a-bc2d-ccffacd915b7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "33a81d40-e5ec-4485-a212-f01880ab9f20",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "852f4b2b-5612-4818-b538-f8c63c1410c3",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "40f2a97a-3aa2-4381-82c5-90e04477d7b0",
"db_country_code": "sample string 28",
"feelist_id": "e861a675-5a46-4800-8d1c-f56977013965",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "18883bbd-9b07-49c2-a5e8-f36579c85dc6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "78e5caf7-7554-431e-a16c-46318461a7d5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-29T02:59:36.7075896+00:00",
"db_currency_id": "37eb32de-7313-4b87-b2f8-d2af431b53a9",
"db_currency_code": "sample string 10"
},
"company_type_id": "30075fc6-875f-4ff6-accf-4dc712d547e1",
"company_type_name": "sample string 32",
"company_type": {
"id": "ae0dc47c-2d23-4e2a-83b6-7198731997d9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1cfa7f37-7ae8-4bbf-bd96-456b8ca90ca0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bc219d13-f6fe-44a4-a8db-d13f020cf5fa",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a20a63d0-b6d8-45e2-a8a0-d3ba75e93e39",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2eeeb0ca-7c5b-477c-b54c-ad319a976d4a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5e8658ed-d7f1-439c-bc84-344aec28254f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-29T02:59:36.7075896+00:00"
},
"company_sector_id": "67c5eb58-24bd-4688-aab3-c7e838775a65",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "90fd7c39-e0f4-4a60-8067-3370999475ee",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5f2bf8df-609b-446f-9f2d-78f9a9f4615b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "45b5729d-e737-490b-825a-29536d4e7920",
"account_manager_user_code": "sample string 56",
"company_status_id": "a9c2fa09-b425-4b5b-8e7d-3958ee0513de",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-29T02:59:36.7075896+00:00",
"id2": 60
},
"db_language_id": "bc6abbc0-eb19-4d7e-b731-2d82b3746a48",
"db_language_code": "sample string 7",
"db_title_id": "e7609106-d9fc-487e-b8e0-e8ee03901b0b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-29T02:59:36.7075896+00:00",
"create_date": "2026-08-29T02:59:36.7075896+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2026-08-29T02:59:36.7075896+00:00"
},
"modified_dateutc": "2026-08-29T02:59:36.7075896+00:00",
"id2": 22
}