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": "2b6f8ed9-9575-4574-a864-98140241c283",
"_parent_id": "b373fbec-b397-4007-a308-bcec3ec615cd",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "0cc42289-e1e3-42d1-89df-02570c9579d4",
"company_id": "7aab2dbf-6a52-4506-bdc2-dd3847cf9af7",
"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": "3c6cb845-4717-445c-9290-6c6b1d48a31e",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "acc483cb-92ae-4933-aab3-292c0ba39cd0",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ecc65a15-0567-4c91-8a2e-9811b4e9ac36",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d9b0d1ee-e384-44ac-b698-42bca2b033f0",
"company_code": "sample string 5",
"company": {
"id": "9b2725ac-8e09-4b53-88fc-3601e6b51109",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-13T04:14:52.4816203+00:00",
"sales_territory_id": "1e652353-d63f-4c9b-89e3-6c511f94a4cf",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c76ee074-c0c9-476b-b81b-14db6f19e84a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c9f4dab9-5aab-429d-8b24-182cbc7e6ac6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3bfad683-9b48-48df-8e01-71ece3f4e15e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16cb59af-6ace-41b7-826a-32b1fc34ae3c",
"db_currency_id": "1026d4f6-5eef-4afa-9636-e3b56fd67ec6",
"db_language_id": "b6e1bef1-78eb-4c2b-8497-e19ddd4212d5",
"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-03-13T04:14:52.4816203+00:00"
},
"modified_dateutc": "2026-03-13T04:14:52.4816203+00:00"
},
"marketing_segment_id": "da57b3a6-3b10-4819-aa37-85b4661756b6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4d4ed51a-74ee-45d0-8f37-be6b8b8d0536",
"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": "59ffab92-4662-4fc1-a36a-6064be0fde55",
"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": "33843976-2852-4602-95fe-4884d09ce064",
"db_country_code": "sample string 28",
"feelist_id": "a7823cec-6e67-4aff-9187-81973d698084",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8cdcd765-b8dc-430a-95be-bd150ce59cea",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b855136e-6a33-4eb9-a1e8-c99f6d5e7d90",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-13T04:14:52.4816203+00:00",
"db_currency_id": "c940101a-e815-4ca3-ab7e-f9123437ceb8",
"db_currency_code": "sample string 10"
},
"company_type_id": "053fe88b-cef4-4d08-9b23-a9796ce93669",
"company_type_name": "sample string 32",
"company_type": {
"id": "b4e7f54a-7269-4881-8f47-6ea06d4e14a3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2270a383-8329-47eb-9df7-c17d3f592f32",
"sales_organization_code": "sample string 5"
},
"db_language_id": "75c22444-b467-44d4-b653-369ea75923f5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0c520e9b-08dc-4157-9e69-2ba69b936978",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ce3e60d8-dd08-4db4-96bc-0479f0122774",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "59e020e8-2309-41e4-ab16-b54dcbf88c8a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-13T04:14:52.4972432+00:00"
},
"company_sector_id": "734e2889-e4af-4bf0-b102-6c84f6567737",
"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": "4bad7753-1d59-41fd-baa0-2d10ebcdc469",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "273dc75d-1468-48a3-9582-cdf00b92a452",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0bef1e5c-d451-49b6-9d54-867e56420e49",
"account_manager_user_code": "sample string 56",
"company_status_id": "dac2fa9e-1327-4d54-b3a6-e9f0415c0697",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-13T04:14:52.4972432+00:00",
"id2": 60
},
"db_language_id": "3b2e734c-ac6a-438b-8fff-e7cf4fceb177",
"db_language_code": "sample string 7",
"db_title_id": "bbdaeb3d-f7fc-4f6a-a06c-f8ccb6c1c6c6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-13T04:14:52.4972432+00:00",
"create_date": "2026-03-13T04:14:52.4972432+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-03-13T04:14:52.4972432+00:00"
},
"modified_dateutc": "2026-03-13T04:14:52.4972432+00:00",
"id2": 22
}