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": "6d37a0f5-0d5d-42e1-bbea-002fd73282b7",
"_parent_id": "2de8e633-bd21-4b47-a11b-997b3b2797be",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "0f3f9826-3f6d-4145-ac3e-7fee5186cf97",
"company_id": "794351e4-ef61-44ad-857c-287acaa61cb1",
"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": "eb0099ad-a91b-4358-bbd4-5aa0e80b90da",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "956c7024-e44c-4cf4-aa81-41cbaa34092d",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "924fb68e-85be-4a4c-a550-c13968a6dd13",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "eeb587fc-5f4f-453d-b6e6-c5f5ba35f294",
"company_code": "sample string 5",
"company": {
"id": "53b8ebfd-b60e-44db-b7d6-be4dedd76142",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-25T21:36:39.6877663+00:00",
"sales_territory_id": "9d227346-a9bc-434a-83ce-dcc405da3560",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9988d529-ca50-4ef7-9ba2-5e9e99b42723",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ecae710b-f534-4b33-b133-e99a3a852300",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a8bb4c0c-85b8-4381-b536-cefdac9e76bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8f500a68-82ff-4cd0-8bfa-c405a56afa63",
"db_currency_id": "e25c61d6-1b5d-446d-8b3e-29b65776c695",
"db_language_id": "3c92aed6-4365-44dc-aaee-45e34f16d7b7",
"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-06-25T21:36:39.6877663+00:00"
},
"modified_dateutc": "2026-06-25T21:36:39.6877663+00:00"
},
"marketing_segment_id": "aff84eca-5cd8-47db-b0f7-0ca91457dd75",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e4324749-952e-4084-8188-1100c60378f0",
"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": "f19e67f6-7b05-4a78-8c33-2848df538abf",
"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": "9aaa7449-ab2e-4bec-8974-7338edf3f73a",
"db_country_code": "sample string 28",
"feelist_id": "ac80342b-7bdc-449d-9d74-a6c3fb344d37",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8edf2a2a-9d36-4ae1-aea6-8b915746a638",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6f9917b7-520e-4c33-9da0-26cbd21ac146",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-25T21:36:39.6877663+00:00",
"db_currency_id": "34135393-dda2-4992-b3fc-37bdf8247843",
"db_currency_code": "sample string 10"
},
"company_type_id": "bb4bae1a-80c1-4b04-87c1-1b0aa1dcfec5",
"company_type_name": "sample string 32",
"company_type": {
"id": "b9e6731a-8857-46cd-8c60-7d3ef443e8bd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4b0025a6-2d0d-45a5-8c57-83eef2302402",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9cf14dc9-2d76-47c4-bdfc-364e852a0c28",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "88579a0a-9df9-4872-85bc-fdf7c17bb3e4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "76f49905-54fe-40f4-b137-79c75c05df4a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "cf26db4c-2e5b-43ca-bfea-2c2a9bf37bca",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-25T21:36:39.6877663+00:00"
},
"company_sector_id": "def4a2fb-3476-4aa7-ba56-8db3b26f4bb1",
"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": "a9b30e42-1c1f-46dd-ae0a-14fa44c087b5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ee365c98-b832-473b-af5e-53e428e9898d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "da0fce2f-e063-4368-8cee-441d4f0b00e5",
"account_manager_user_code": "sample string 56",
"company_status_id": "16ca79e1-018d-4a2d-8497-c4dc7b66091f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-25T21:36:39.6877663+00:00",
"id2": 60
},
"db_language_id": "7822b470-e54e-4be7-a72e-0d86ca5182a1",
"db_language_code": "sample string 7",
"db_title_id": "843cae62-1d31-4377-9824-caab69d4e600",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-25T21:36:39.6877663+00:00",
"create_date": "2026-06-25T21:36:39.6877663+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-06-25T21:36:39.6877663+00:00"
},
"modified_dateutc": "2026-06-25T21:36:39.6877663+00:00",
"id2": 22
}