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": "b44a10ff-3f08-460a-be3b-da3e1fab4589",
"_parent_id": "5ffbd5a8-c42b-4c90-8655-69cf26543b24",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "aba92507-36c2-40b1-8812-a63b8037c1be",
"company_id": "0af91261-f8f9-45df-a905-98523251c4ef",
"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": "428be4a9-7282-462d-bd22-ad0df45a571b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "925464ba-5589-4452-aed7-79130343f1ce",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9707a865-3482-48b5-88eb-fdf694505d66",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0a4e27e9-4b34-4666-8840-f3fd1f98da2c",
"company_code": "sample string 5",
"company": {
"id": "a66466e0-850c-4c31-bf58-c55551a80611",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-08T05:05:37.8635381+00:00",
"sales_territory_id": "e8308453-ffb3-4215-a214-adbdaa85b373",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "30188059-5e9b-47d6-a738-a83e7fbb6ff6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "65a03d06-6876-4dd0-bb4c-1f07037d4849",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "92b91e97-a611-4e18-a495-a58c92fef584",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f194c2d2-5ac6-4d0c-aa3a-5fc3b42f7946",
"db_currency_id": "e9b334ae-4b94-4077-b7e1-d4cf3734875c",
"db_language_id": "92fbeed0-f2bc-4214-9c10-9dea441817a5",
"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-10-08T05:05:37.8635381+00:00"
},
"modified_dateutc": "2026-10-08T05:05:37.8635381+00:00"
},
"marketing_segment_id": "f0e1ba32-f9dd-42b3-98b8-a8bb2c9505b6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "25e35bc7-d657-475d-a586-108b87f14784",
"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": "bcf72c53-61be-46b1-880f-fcf88027a46f",
"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": "4e1eb986-f022-4c1b-a6b5-7f85ac68482a",
"db_country_code": "sample string 28",
"feelist_id": "e4950d4f-5f50-48dd-bf6c-4781dbc7b929",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7d354c5f-f802-4745-8f67-b101fea4aab0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "28ea837c-e6e0-4fb6-9508-b5f455ccd651",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-08T05:05:37.880621+00:00",
"db_currency_id": "adad46a6-a772-42aa-be30-0554b0709b65",
"db_currency_code": "sample string 10"
},
"company_type_id": "0d684b77-07f7-42fb-9d08-fc73d9da1eae",
"company_type_name": "sample string 32",
"company_type": {
"id": "a1b7b7de-588e-470f-b769-573987a4f861",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "db0eacf6-59e9-4383-806e-d7b2a0ff1d96",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bc1d5bc8-60d0-424e-a0fc-fcf833107984",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c7b964b1-c466-48ee-afcc-1811c6fa003b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "442b34c6-3e6f-44a2-85b7-7a167a9ac618",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d8e2cf76-cf73-4253-9331-43711d4886cf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-08T05:05:37.880621+00:00"
},
"company_sector_id": "3de92a2e-d6b2-496a-9cb7-e6278bf8642b",
"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": "94f33e89-9683-4b88-b5b4-41ddd464309a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1690ef92-ad37-4b4d-9389-1947a24a00fc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "76f4da05-013c-43b7-9c76-df1a811cf136",
"account_manager_user_code": "sample string 56",
"company_status_id": "399eace5-9ed2-41ec-bab0-d5271adbf1a3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-08T05:05:37.880621+00:00",
"id2": 60
},
"db_language_id": "5257c0b1-0231-4335-a228-09300aaacdf0",
"db_language_code": "sample string 7",
"db_title_id": "e7006394-2638-46d1-a3a3-66cc3b5fa5c7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-08T05:05:37.880621+00:00",
"create_date": "2026-10-08T05:05:37.880621+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-10-08T05:05:37.880621+00:00"
},
"modified_dateutc": "2026-10-08T05:05:37.880621+00:00",
"id2": 22
}