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": "25bcaa21-1ec5-42ec-89bc-7cef9e36db5a",
"_parent_id": "c9ed40dd-16ac-4890-abad-cc3ff94c5cd5",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "5db682e6-4bb6-46cc-9864-d08ac6bff1a0",
"company_id": "1c9d9cf9-8b0a-415d-b636-517ed893d968",
"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": "0be3d38c-d80c-4b30-83d6-d700fd14c138",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "daaac535-a4c1-467d-af9e-fccae7fb1def",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f1bdc44f-ce67-4739-8f6f-3bc936a08699",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bc6a58bd-fd3f-46c6-97da-8328797e6380",
"company_code": "sample string 5",
"company": {
"id": "a3ca6509-9f23-4602-8999-2d6875527d06",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-17T11:04:32.4658166+00:00",
"sales_territory_id": "d154e332-2346-4b68-b5ee-674e0436402d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "277e0220-7439-4da6-9f91-385a032681f5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "66a1eda8-f30c-4ec9-b015-986689c4f306",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "887ce7d4-20d4-4f24-802a-47b077445acc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da75917d-d9f6-4265-88f0-1c91d849845c",
"db_currency_id": "18a601d0-7cc6-4fb7-abff-b53d17a2c23d",
"db_language_id": "285da5d3-3d18-4767-a632-b1e9d4069b0b",
"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-02-17T11:04:32.4658166+00:00"
},
"modified_dateutc": "2026-02-17T11:04:32.4658166+00:00"
},
"marketing_segment_id": "6777c5bb-e6c1-4731-aad1-f6ed0f101f3f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8a74d06b-d35b-45b6-96d0-bb0a571abef8",
"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": "9f629889-9d82-45d9-a4b0-71727d7f455e",
"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": "50aa5f3a-c7d4-4d6f-b159-c49bb3c54747",
"db_country_code": "sample string 28",
"feelist_id": "71c494cb-9afe-48e0-988e-271287af9f7e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6d2acd4e-bff7-4a9b-a5ef-250145a4b210",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f55fee7f-ba0c-4513-948b-16cba54c6bca",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-17T11:04:32.4658166+00:00",
"db_currency_id": "1caadcc9-e568-4830-857f-61f5f7388e67",
"db_currency_code": "sample string 10"
},
"company_type_id": "0813b8e8-7214-4357-a8e0-34173cd4288c",
"company_type_name": "sample string 32",
"company_type": {
"id": "65bdc774-c972-4188-b0a2-1b2655fa4ea5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3fff680c-fc1c-4b7f-a017-5fd24e341669",
"sales_organization_code": "sample string 5"
},
"db_language_id": "aff9f2b1-710f-4c87-8a6d-f75755922234",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8e432e90-2a81-4d02-a5f1-9f721413fb1d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2b5babfd-2a7a-4ac2-b5e8-e9c64cebfee4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e8080422-c90d-4ae9-be74-6e1ffb43ca15",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-17T11:04:32.4658166+00:00"
},
"company_sector_id": "293d923e-0da7-4684-b262-e4cd04ef5dbc",
"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": "0267cacb-6633-4b6a-849b-01f10aa6e137",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4ccf1f86-dc2f-461b-8c0e-c54a44824865",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ef13010f-a8bf-4af9-80bb-0972b518697d",
"account_manager_user_code": "sample string 56",
"company_status_id": "b86a6e36-ee77-4ea1-b36d-72b25b47682d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-17T11:04:32.4658166+00:00",
"id2": 60
},
"db_language_id": "a29bee1b-e5a3-43b7-8b1f-8baa3462e4c4",
"db_language_code": "sample string 7",
"db_title_id": "f94abffa-8084-4e62-af37-665951acf88d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-17T11:04:32.4658166+00:00",
"create_date": "2026-02-17T11:04:32.4658166+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-02-17T11:04:32.4658166+00:00"
},
"modified_dateutc": "2026-02-17T11:04:32.4658166+00:00",
"id2": 22
}