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": "892dff2c-3b81-4774-b818-6a80ba4f1489",
"_parent_id": "9c3d149f-e9ee-4269-8b67-9de79e7c52a2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6927bb15-9a3d-4e86-8ce2-6fbd31a668bd",
"company_id": "78fe955e-cff5-4d8c-bfb5-7eb93c78b05a",
"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": "b35ac028-44c3-4e38-8b1a-fff29623faf4",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3b0c3cab-8be4-40ae-830a-b3dd61493884",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "bcb1d7bd-f442-4cc5-986c-30eca55bcf6b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2701dc76-889d-460c-8dda-bd43dbf2d1ca",
"company_code": "sample string 5",
"company": {
"id": "23c7141b-d8a7-4e76-8f78-b8e7491c218b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-05T22:16:43.2314315+00:00",
"sales_territory_id": "0acc05d3-9901-4536-af9b-ad3afeb8a58e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c968f1d7-306e-485b-8544-e309bfff76fe",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5725ff38-6a5a-43ba-80f8-8579c7391087",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "efb1342f-d582-46e5-bf28-c3d30b097acf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94f850a3-c7b5-44b7-81ed-116a47bcbca5",
"db_currency_id": "22aa1ad8-5831-41c4-8e70-b708bc6dd4e4",
"db_language_id": "de258694-9a64-40fd-ae41-005d9fd4bc42",
"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-07-05T22:16:43.2314315+00:00"
},
"modified_dateutc": "2026-07-05T22:16:43.2314315+00:00"
},
"marketing_segment_id": "8358a799-2255-4ca4-9d5b-aa0985b4e8be",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a4a8cc1b-ea85-4d4e-adfc-7f25c03f87d9",
"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": "c34f06d5-19be-49b2-abd7-04b1efd0cb31",
"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": "6f156bbd-621b-40d5-8d22-7412e331bb4b",
"db_country_code": "sample string 28",
"feelist_id": "311a8d89-c730-4c73-bb05-35dd49b3707f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6a64a1c3-21bc-4d8e-adb7-a5a5d92e5c8a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7badca69-132d-4a7c-9285-a297c21e1fee",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-05T22:16:43.2314315+00:00",
"db_currency_id": "6f15761c-d01f-41b9-b2bc-1cdb0f6957d5",
"db_currency_code": "sample string 10"
},
"company_type_id": "12983d3f-1dde-4aa3-b234-539c42e2fa8f",
"company_type_name": "sample string 32",
"company_type": {
"id": "7344d47c-165b-44a6-aa4e-5e1d84bf027e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b75a356a-1d1d-4b69-8dbe-ddc0ae2ad82c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e327523f-491b-40a1-ae40-4c052d256a31",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c202cf10-e039-43da-a71f-cb5429569e52",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "98397fed-bc0e-46cd-8475-e63b9d272e75",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3a319873-33d4-4228-9dfa-baceaa2bb213",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-05T22:16:43.2314315+00:00"
},
"company_sector_id": "4c110de8-60fe-439f-97a0-61cb5afb0f8a",
"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": "55203e9c-33a7-48b5-9a86-c1e1f96f33dd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ae213fd6-ff6a-4501-8428-d3280e54621d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "dec9738f-c638-4b66-9833-9c5d8c3a97b7",
"account_manager_user_code": "sample string 56",
"company_status_id": "10f5c853-6bc7-4d99-84ba-a00d76bbc49a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-05T22:16:43.2314315+00:00",
"id2": 60
},
"db_language_id": "bcd66c47-d48a-42d0-8ced-605c3a128a39",
"db_language_code": "sample string 7",
"db_title_id": "0bc9b259-d91e-4252-a247-c811c6cb6009",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-05T22:16:43.2314315+00:00",
"create_date": "2026-07-05T22:16:43.2314315+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-07-05T22:16:43.2314315+00:00"
},
"modified_dateutc": "2026-07-05T22:16:43.2314315+00:00",
"id2": 22
}