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": "59cc9d98-854a-4b95-aae4-f78d369b8c8b",
"_parent_id": "6bc93e08-ca4d-4485-885e-60614d3e571f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2af6c57a-2f59-45d9-9dd0-ef73f36365fd",
"company_id": "61e4d897-85b5-4925-b877-827284932e04",
"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": "2e3f8bb6-9c10-40ca-8af4-88395256157d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "21eb3e23-3ab9-472b-bc9e-fa4a03d9792e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ca80f173-da3a-40e9-a42b-88deb620f9a6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e5467f98-22b4-49d3-b2ec-6fa590f8a75b",
"company_code": "sample string 5",
"company": {
"id": "72a3cf68-7290-4984-9f70-740ee4a8d6fd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-26T10:26:25.2462381+00:00",
"sales_territory_id": "2adb3527-9ac8-481b-9293-e70491615a11",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b90fcca3-d477-4fe6-a12a-c03169811325",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5974b7c3-b54d-439b-8e4f-980da61fabb2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "05a14037-01fd-4da3-912f-149bdc81e848",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ff5ec4c7-fc0d-4e11-8554-c3c5c5727296",
"db_currency_id": "231afe3b-a92c-4e55-be11-8db252643f1f",
"db_language_id": "caa196fb-4ee1-4be9-9604-811c614a8170",
"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-10-26T10:26:25.2462381+00:00"
},
"modified_dateutc": "2026-10-26T10:26:25.2462381+00:00"
},
"marketing_segment_id": "465abce0-21de-4c35-b0df-5b5ac2db7c01",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "027c353e-684c-418f-9a4c-278d82deaefc",
"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": "07cd3b51-ddc7-4ff0-b833-1c7b1fdc6a1a",
"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": "98d6df4b-af1b-4df0-89b2-c18802a85cca",
"db_country_code": "sample string 28",
"feelist_id": "d5cc6126-38cd-4e0b-be6e-a2d8abe57e45",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "135721f1-ba48-43f9-b855-b9fdbbd7310b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6a05df67-84f2-4685-9d8d-21addf2b6c00",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-26T10:26:25.2462381+00:00",
"db_currency_id": "21db5175-6eeb-4601-bf70-b052c847431b",
"db_currency_code": "sample string 10"
},
"company_type_id": "533122bd-1040-47c0-b70e-22d9cefb20fc",
"company_type_name": "sample string 32",
"company_type": {
"id": "b6d1b98c-c67c-448d-9bbf-027a76b4592c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "635414b8-6a31-4787-8555-d89a03a95e07",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e5398545-74d8-4214-b0c9-fa538b1aa69b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "287411a4-923d-4330-bbcd-8a6e675c1ad7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c4deb176-c87b-4e0b-9b43-5a871df295b6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b180bcc3-31ee-4bf3-a262-03648328ec11",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-26T10:26:25.2462381+00:00"
},
"company_sector_id": "6308b863-ab1d-4c64-a165-15c973e93d7d",
"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": "a6285d7e-fd40-4ef3-969c-8caf014c27f3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "269e8105-e35e-4214-b25e-876c35acb03d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fbb9b662-7d48-487a-9755-bc841e01e078",
"account_manager_user_code": "sample string 56",
"company_status_id": "17b84d07-355e-46a3-a5dd-10f932b50a37",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-26T10:26:25.2462381+00:00",
"id2": 60
},
"db_language_id": "399d79a8-b176-474b-9492-62e36d3a69e5",
"db_language_code": "sample string 7",
"db_title_id": "36df5131-ecaa-4e25-b61f-241a1481e0a5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-26T10:26:25.2462381+00:00",
"create_date": "2026-10-26T10:26:25.2462381+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-10-26T10:26:25.2462381+00:00"
},
"modified_dateutc": "2026-10-26T10:26:25.2462381+00:00",
"id2": 22
}