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": "2dfcfc79-4490-460e-b2c8-a3c0a1aac6fb",
"_parent_id": "10f9e7d7-69d8-47d4-979e-3677b3917a1f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f1612b53-87ac-4e4a-87d9-2a55394c1b69",
"company_id": "885e747c-7f6b-4a23-a6b2-396bd1b4f4aa",
"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": "bd836cf3-a2eb-446a-b22f-095f593a2d92",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "45c53b0a-e3f5-4cb1-8e54-1dcd935db7b9",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "7ec41ba5-7f63-4304-a0bf-46188951ed15",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "614536ea-1a80-4da4-a5cc-d2e2ee3de570",
"company_code": "sample string 5",
"company": {
"id": "847c895f-1316-4397-b6af-631b3091593a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-05T18:48:34.6936782+00:00",
"sales_territory_id": "18945d8d-a49d-4315-a19e-5076e086a115",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0d5792f9-b1d8-4ca1-b424-2ff85464fe66",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1ba76903-8dab-4f7a-8555-6f564edc2e92",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "66c66988-c681-4eae-80d8-9259a7609078",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ae8bbb2-e1be-4505-a3c4-5d7753ebe0d6",
"db_currency_id": "72429f34-5f37-47cc-8292-0cb9063a442b",
"db_language_id": "22e926bc-05f8-4847-b361-35fd84a21988",
"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-12-05T18:48:34.6936782+00:00"
},
"modified_dateutc": "2025-12-05T18:48:34.6936782+00:00"
},
"marketing_segment_id": "705f28aa-5e3d-4511-845b-b3c7eb201dfe",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "abf313f5-b428-40e0-a559-886492b0234d",
"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": "560729e3-e952-4158-b2b3-bbdd1ccfc594",
"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": "76c882ae-5499-4d11-8a90-4167a6957b57",
"db_country_code": "sample string 28",
"feelist_id": "45fe45f4-5818-462a-beb4-f4bef7e7b10c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "992379b9-5470-46df-8a48-8a2a921c4ab4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4669d237-65b9-4cd0-a3e7-57938f6f0193",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-05T18:48:34.6936782+00:00",
"db_currency_id": "122481d3-2dd3-4b02-b81a-d6cad874809e",
"db_currency_code": "sample string 10"
},
"company_type_id": "15278af2-99f4-4caa-b679-1263bedad309",
"company_type_name": "sample string 32",
"company_type": {
"id": "f17dd59b-e0c2-42ef-ab2d-9df8970a8f20",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "11908584-0387-421c-a675-e26ce54f21c6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "17ed74a0-622b-40a8-b8cb-b1f6d0e26d8e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1c6abbb5-5fa6-4240-8f07-52e3285e13a5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e08186d6-6bd6-46f7-acf8-85dae948f34e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "35135858-2a86-4f6c-829b-402c5b79e653",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-05T18:48:34.6936782+00:00"
},
"company_sector_id": "34c73a59-9d1e-4902-8522-a1d231712de7",
"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": "1701f548-ac1c-49bb-ba1a-1330701d69ef",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d43e6310-3f0d-450e-88ea-c2fca64aa41f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "73889f62-6ed8-4456-b67d-310acfab5795",
"account_manager_user_code": "sample string 56",
"company_status_id": "3194495d-d479-4206-8131-a5fb8833478f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-05T18:48:34.6936782+00:00",
"id2": 60
},
"db_language_id": "f5577701-e6b2-4842-b156-de0c8629b8eb",
"db_language_code": "sample string 7",
"db_title_id": "4722fbec-5c37-4861-9909-3115a6704401",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-05T18:48:34.6936782+00:00",
"create_date": "2025-12-05T18:48:34.6936782+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-12-05T18:48:34.6936782+00:00"
},
"modified_dateutc": "2025-12-05T18:48:34.6936782+00:00",
"id2": 22
}