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": "f5d25834-d89b-4efe-8e25-292128593131",
"_parent_id": "547e5c07-64d8-482a-ad78-169a7e50e054",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "eda818e4-c8cf-4bac-88d8-e039ba29bfb0",
"company_id": "748062b5-ed4f-44d3-a2b5-226a4b0496c3",
"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": "62a4b311-409d-441b-83a4-e215d2bdcf91",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "32e8b86f-171e-41bb-92a6-696a9cccd729",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "54dfe55b-a964-4506-b3ac-ec128342e5ef",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9349918d-e2d3-41ab-95ed-49bfd9ed0896",
"company_code": "sample string 5",
"company": {
"id": "a048897f-648b-4995-881f-3c1b76447d82",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-15T08:30:46.8385105+00:00",
"sales_territory_id": "02f2f514-0773-41d9-9b76-8fcfd4d37846",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "57513fe0-1b4f-48bd-b8c9-088eb7e2f622",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0f93d2b5-8996-4879-b850-ef447550a556",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "21a55067-4fe2-4980-a3d8-ded1cee99172",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4751bd7c-02bf-4d08-be19-aff462948e6c",
"db_currency_id": "3c7aa7e9-fea4-453f-bc77-4498a0939e36",
"db_language_id": "e28c48cb-8db8-4a30-9776-ddad38bcdfc7",
"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-05-15T08:30:46.8385105+00:00"
},
"modified_dateutc": "2026-05-15T08:30:46.8385105+00:00"
},
"marketing_segment_id": "8a951ca0-8483-40d7-aa6b-fc5ed37c2188",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f55823da-662d-443b-bdf6-1a70b8d53043",
"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": "084a69c3-8d95-4882-8f8b-d2ac49a2df29",
"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": "785176b6-fd31-477f-9f05-13404f7a9d94",
"db_country_code": "sample string 28",
"feelist_id": "db4c9407-e1d4-40b9-ad4b-cc430b7ba783",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "66953465-18b1-4bd6-895a-696c6f49b08a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3433e18d-f026-434c-8b6b-c714a3682d59",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-15T08:30:46.8385105+00:00",
"db_currency_id": "fd136d84-c229-42bf-b830-e726a99ab5ca",
"db_currency_code": "sample string 10"
},
"company_type_id": "9729a35f-22df-4562-ba1a-df0a8325a2f5",
"company_type_name": "sample string 32",
"company_type": {
"id": "92090104-c098-4081-ad6d-337a23ca7007",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7774a152-b512-4c44-8680-b2e4eb41b229",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4a4d42ba-4ec0-4327-9991-4e61b2c0c9d8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "be46017c-df99-444c-be09-d17d87cfa815",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "41e63b48-0a51-42d3-88ef-bd925d7d9744",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e1c1fe93-d5d2-48e8-8de5-c0b0e0f34863",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-15T08:30:46.8385105+00:00"
},
"company_sector_id": "307cfda2-5fc1-4127-b120-6a5069f3ff22",
"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": "13810d45-0144-4db5-8563-4c5343637d73",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a4711e2d-597d-4eb3-ad9f-374eb2aa9823",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a8e76a9c-49ef-4c90-af31-3feb489ad1df",
"account_manager_user_code": "sample string 56",
"company_status_id": "17d4476c-768e-45be-a13a-e58ecceb2ae8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-15T08:30:46.8385105+00:00",
"id2": 60
},
"db_language_id": "e3326cf8-32d9-4f1d-a118-128186eca358",
"db_language_code": "sample string 7",
"db_title_id": "701f9864-fa12-45a0-be6d-462cc762a439",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-15T08:30:46.8385105+00:00",
"create_date": "2026-05-15T08:30:46.8385105+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-05-15T08:30:46.8385105+00:00"
},
"modified_dateutc": "2026-05-15T08:30:46.8385105+00:00",
"id2": 22
}