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": "c028c018-9859-4e76-a7ef-b367b2f38c18",
"_parent_id": "7d95eee1-aed7-461d-9ed9-690475d0b4b5",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1c5ceea5-25a9-4629-8b91-da69b853e84c",
"company_id": "2e595b28-b249-4f22-8d82-2fbf7b5522fc",
"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": "b142f187-3d0d-4f89-aed0-5566e07bb285",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "24a6833f-7937-4f97-9851-cacd2264d1d3",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "bd14bd9b-f8de-41da-8f58-83f587da8f80",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "00a10678-8fae-49de-b7c9-8a177c8e78e2",
"company_code": "sample string 5",
"company": {
"id": "a4f1c5d2-5dfe-482c-a59d-a45701827704",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-16T20:55:28.1167901+00:00",
"sales_territory_id": "8069cd52-df3d-4bcf-8491-9620dec21810",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "06c6a994-eca9-489d-bf95-6b15318c5036",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "51d7e37a-50c2-41ec-bd91-46cbb2822cab",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "39a7352e-378d-4427-8cd1-221d6efb8a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76da81f0-eb61-4853-bb05-34810670d748",
"db_currency_id": "1f1f9e82-0a09-468c-a638-5d3ea9c4dff6",
"db_language_id": "a243ffdf-13b8-427c-a84b-9df19a86657a",
"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-16T20:55:28.1167901+00:00"
},
"modified_dateutc": "2026-08-16T20:55:28.1167901+00:00"
},
"marketing_segment_id": "34bf6690-2522-4696-915e-63705278be4a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3b9a723a-eb61-4b92-96c0-1549cde2c23e",
"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": "1ab60556-7050-40e0-a7da-6c5d2ef4d2cb",
"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": "d79e5eda-4127-4b63-9eb3-2ea183222cef",
"db_country_code": "sample string 28",
"feelist_id": "1d5fd6aa-efcc-48b5-adf4-aa1671f1d0f6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a1e801df-a820-42e5-bc96-de5f0a41b7a0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1895074d-8493-4688-a46c-b81928341f95",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-16T20:55:28.1167901+00:00",
"db_currency_id": "353af435-5ab4-4c3b-a41f-599dd50b8f11",
"db_currency_code": "sample string 10"
},
"company_type_id": "792688b0-0b54-405b-8098-623e8963f127",
"company_type_name": "sample string 32",
"company_type": {
"id": "48653dac-730e-4881-8612-872bb7d339ef",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ef855bed-0c4e-4507-9723-e25622ec0f59",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b5ea5229-0984-4a1d-8f0a-f251ff532c44",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e90d5ec0-837a-4cc1-84db-5ed93bba23a4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1a0f5865-abf5-48c8-b8c4-28cbf098716e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fd9f1343-4ff3-4802-941c-bf5de98d7bc0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-16T20:55:28.1167901+00:00"
},
"company_sector_id": "ea5720be-2592-446e-a14f-5694d2e8d538",
"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": "e3b0b03e-8c28-40fa-bc2d-388ef3432f36",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0169264f-fe43-40cf-9e57-daa4ed44b50d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "95ce9d88-baec-44a8-acac-6015baf539a6",
"account_manager_user_code": "sample string 56",
"company_status_id": "299999a2-e3ea-4079-ae0b-693195417dcd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-16T20:55:28.1167901+00:00",
"id2": 60
},
"db_language_id": "8ad7ebd5-939e-4b5c-b987-07a76962e3c0",
"db_language_code": "sample string 7",
"db_title_id": "a1243659-f0e6-4833-b785-c9f8f9b2d7ac",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-16T20:55:28.1167901+00:00",
"create_date": "2026-08-16T20:55:28.1167901+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-16T20:55:28.1167901+00:00"
},
"modified_dateutc": "2026-08-16T20:55:28.1167901+00:00",
"id2": 22
}