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": "a96438d7-87e7-41a5-8864-477b52ff12fc",
"_parent_id": "23c36adf-81dd-42c0-b5a8-ccac5a90a138",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c50130d6-2f10-4183-95ae-2c68352b63cf",
"company_id": "b0ccf88e-6535-408b-a6fc-fae5511875a0",
"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": "4b8bc770-7280-455c-b3d4-4c6a18334ee5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "588a51b8-da46-4119-ab3b-ba97e749cc3c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "d4b6398e-7fd0-4795-8991-617c4e98a2fb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7423fa01-afdd-41be-9106-5b0c3d8424c0",
"company_code": "sample string 5",
"company": {
"id": "6ffa437f-c309-476d-94dc-4beb9e5472f0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-10T07:56:18.4765631+00:00",
"sales_territory_id": "b30efca0-14fe-4a0f-a58a-43dfe8b1be39",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e297de1b-2719-42f3-983f-c3344b0fd4cb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "60ccf449-f3a7-4841-b057-aaf3be413f6c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2cadd8ef-5e52-44b8-b1e2-175db7819804",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3cef878-7794-4f77-9a86-2ec9917f4e8a",
"db_currency_id": "74bccd2f-31e8-45a6-ae91-acf868431617",
"db_language_id": "b733e80b-5901-4d23-bfb3-dc42b34fcd99",
"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": "2025-10-10T07:56:18.4765631+00:00"
},
"modified_dateutc": "2025-10-10T07:56:18.4765631+00:00"
},
"marketing_segment_id": "8ba57d32-9ad0-4199-ba9b-3e27fdf2d3b0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bc3ac587-c492-4869-ac9c-cde052180480",
"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": "3f569066-07f3-497e-8f87-577ebd277c03",
"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": "0778edd2-19f8-413a-8bb9-61a8a4cea657",
"db_country_code": "sample string 28",
"feelist_id": "5e0da907-190d-4508-acad-369ff9070e11",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8aa494d8-9a9d-45d1-bbe0-4c240ec5a552",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3c603a48-20f4-4f63-9057-9ac22cd819ee",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-10T07:56:18.4765631+00:00",
"db_currency_id": "d9520af2-0f8f-429c-a51f-8f248dea4856",
"db_currency_code": "sample string 10"
},
"company_type_id": "e6b26fb3-4870-4bd6-abb0-186b6d6adafb",
"company_type_name": "sample string 32",
"company_type": {
"id": "18b51c2d-b821-4807-9b80-0f9e15e41e40",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b5f7859c-5437-4e0e-be1d-daa897a514da",
"sales_organization_code": "sample string 5"
},
"db_language_id": "afc92ec3-e11f-4346-9bbd-3356c6d4e25c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5726ae7e-868c-42c3-b7d2-2f2a435a58d5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1ace2693-5eee-496a-922d-f4f8bde4a546",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9c1b9639-a148-4d33-b1f2-b5e9b2dfc3ec",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-10T07:56:18.4765631+00:00"
},
"company_sector_id": "2674cf75-d3d8-48c2-9a09-bbcb191bbf6e",
"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": "59366d10-db24-4e10-a1fd-6452ecdfb88e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bb546439-b0c7-41dc-bc4f-f5162e23409c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "13f07c55-10c7-4182-bfb0-ec44b068a65d",
"account_manager_user_code": "sample string 56",
"company_status_id": "33d865b4-fa18-4802-86ea-2ccd993411f3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-10T07:56:18.4765631+00:00",
"id2": 60
},
"db_language_id": "c948b939-e106-4f65-aaac-00f186721e58",
"db_language_code": "sample string 7",
"db_title_id": "a1965a4b-6478-4ee8-92a3-e825e31cf66c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-10T07:56:18.4765631+00:00",
"create_date": "2025-10-10T07:56:18.4765631+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": "2025-10-10T07:56:18.4765631+00:00"
},
"modified_dateutc": "2025-10-10T07:56:18.4765631+00:00",
"id2": 22
}