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": "423bb07d-a15a-46ae-b48c-536dbf49043c",
"_parent_id": "5b7de4af-4999-4fa9-a693-373670a59ad0",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f5bbcb78-c965-4059-acb4-46069cafd42f",
"company_id": "4b3831d4-2e54-48f7-b962-a5c2055ab016",
"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": "ac062e42-f326-46de-9826-243981206862",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "10c67cf6-19f8-4872-aab8-bd0c542188c8",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "468fc287-d0b5-4256-8d75-5d702a916ec4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "96b551b4-b6f8-41c3-908e-fe72f99667e9",
"company_code": "sample string 5",
"company": {
"id": "a3a5cc60-da0b-43fd-a5c9-c359b52ef03a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-21T17:45:24.2692233+00:00",
"sales_territory_id": "9aabbbc7-6fec-454c-8c68-48107f1065f3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "24a3888c-d7da-44ea-aa8b-eb4861898976",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c4cb986e-a287-4f46-93f0-fadb0fb61a13",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3a66a71d-824c-4ee0-82dc-36d75a7970bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54635ed2-f477-4c0a-abe4-502ad635060e",
"db_currency_id": "0020dd8b-fedb-4815-9578-2552c4872a2a",
"db_language_id": "560767f9-cc73-41bc-8c66-66cfacaa5a5f",
"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-04-21T17:45:24.2848437+00:00"
},
"modified_dateutc": "2026-04-21T17:45:24.2848437+00:00"
},
"marketing_segment_id": "94eda0f5-41b2-4eb7-8f71-9e6de6b211a4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "259dfea9-2fe2-4a70-8f0f-05ff0dcc01a2",
"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": "ec4542c0-c5ec-4c48-87e4-8bba28c7f49c",
"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": "cda20b60-2f6f-4c09-93bc-33d0c205f40d",
"db_country_code": "sample string 28",
"feelist_id": "1c7ffc37-67cb-41a7-93b0-63bb006e652e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a933e955-0d1f-41b6-ab7e-322ca00a94ff",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fed27611-fa07-46d0-bfdd-9ff3bae32a32",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-21T17:45:24.2848437+00:00",
"db_currency_id": "c0eedc80-b4ab-4040-89a5-fa9b1767a877",
"db_currency_code": "sample string 10"
},
"company_type_id": "11fc202f-79a8-4e3f-811e-26bde798cf99",
"company_type_name": "sample string 32",
"company_type": {
"id": "ea4938c2-e132-4387-88f4-7454395fbd40",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e817025d-a791-4b1c-9eb4-f4fe30bbcec9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e8fdb167-647d-4fc9-a13c-032100ea69de",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8e91fcb0-3d87-4070-b251-a47062994f47",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0161af81-0de3-4ef2-b142-54714e98a57d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "decd5f00-a8fb-4fb4-9259-6b3448007ff0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-21T17:45:24.2848437+00:00"
},
"company_sector_id": "3fd09521-1365-476e-811e-c6587cc21d0b",
"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": "d66cb2fe-c2c8-4641-be41-7cf26dd1ef6e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "49c20207-8003-4a30-8283-01450f650450",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8bcef4e5-8601-4f0e-b803-9d90c0580ee0",
"account_manager_user_code": "sample string 56",
"company_status_id": "052b73dd-681d-4971-89ec-e87f7fab0352",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-21T17:45:24.2848437+00:00",
"id2": 60
},
"db_language_id": "25025807-73f1-49af-9116-b352c06c3191",
"db_language_code": "sample string 7",
"db_title_id": "b4287a9a-0e21-4a29-b68b-ca11cd048cf8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-21T17:45:24.2848437+00:00",
"create_date": "2026-04-21T17:45:24.2848437+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-04-21T17:45:24.2848437+00:00"
},
"modified_dateutc": "2026-04-21T17:45:24.2848437+00:00",
"id2": 22
}