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": "5cfd5c2f-4a85-4664-ab1e-75511179ac41",
"_parent_id": "85f9cb38-c1cc-4b99-b363-aa26719deaf8",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "3f194334-bedb-43c6-a2e4-2a86b15241d2",
"company_id": "3d659c4d-932a-464c-b8b0-a772caf70337",
"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": "d1ed8d7f-7a6a-46f0-8a5d-c4f08e2d0397",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0c8d9bf3-c094-47f7-870a-dcc0a1223f55",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3144e930-2308-4ed3-b5df-c341fb9ba2a2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "247f674a-1767-47a4-8307-c21ffc7ff83d",
"company_code": "sample string 5",
"company": {
"id": "14863550-6e78-4329-b0b3-7e838a598710",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-16T08:59:31.724113+00:00",
"sales_territory_id": "9beec492-3f4b-42b8-bb2e-9e71b94a483b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c9576c80-7e20-4d84-a27d-4f802d3d4e99",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5be24195-241a-4073-b6f6-6ee25159881a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "966c5578-6122-46f1-9ce4-b762c215eb22",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ce733207-a94d-457d-9d74-78a0ec3b1e6e",
"db_currency_id": "39b93d77-113a-4329-844d-35c14a334750",
"db_language_id": "14bbc369-d7a4-4eca-a5b2-24208efceedb",
"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-09-16T08:59:31.724113+00:00"
},
"modified_dateutc": "2026-09-16T08:59:31.724113+00:00"
},
"marketing_segment_id": "b4b6d1f0-1a65-4f0e-832e-ee5e2a977cfa",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0bfb4680-1645-43db-990b-eba1e9346f1f",
"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": "97d155db-267e-4e11-8b5d-3809b7c2065a",
"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": "35e6cc1c-0e86-420a-b42f-3f70cb3e822b",
"db_country_code": "sample string 28",
"feelist_id": "bbbcd541-869d-4acd-97ae-9901b959d45a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c4cd5b36-e81b-4e24-b62c-34e5adb575f7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "399701ae-5b28-4be5-911f-4f1807f227a6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-16T08:59:31.724113+00:00",
"db_currency_id": "a719dc9e-acb9-4ec9-94d2-5ef5c4a72fba",
"db_currency_code": "sample string 10"
},
"company_type_id": "f4520ceb-0b6f-4e5a-850f-773dbb9e88b6",
"company_type_name": "sample string 32",
"company_type": {
"id": "3720b711-16b4-413f-aa1d-5b2bf6ae1f48",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2f4ff012-b5bc-44de-a4d9-00f6fd30a846",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ba1902b0-d92f-4d10-abe0-4a5dbada2b45",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4f4bf5e0-fce6-469b-83b2-0d0e0ae60673",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1d659dba-de2d-4994-afe2-8f8e06eb9e68",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bea4ea83-c0c1-44be-97ac-99ce4b0ae50a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-16T08:59:31.724113+00:00"
},
"company_sector_id": "7c005deb-d311-4c05-93e0-49829da96c05",
"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": "a1817049-f16f-492b-a64b-8fc42d76f8f9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "af4e7f9a-18db-466e-984f-47f47ba7c007",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e8cb7459-be83-481a-bb96-50e2c590ac43",
"account_manager_user_code": "sample string 56",
"company_status_id": "e069440d-9bbb-423f-8050-d433c5889f01",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-16T08:59:31.724113+00:00",
"id2": 60
},
"db_language_id": "24509bc4-e818-40bf-9604-275824f078c2",
"db_language_code": "sample string 7",
"db_title_id": "ab9aa6f2-a127-423e-b96e-27730cf26426",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-16T08:59:31.724113+00:00",
"create_date": "2026-09-16T08:59:31.724113+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-09-16T08:59:31.724113+00:00"
},
"modified_dateutc": "2026-09-16T08:59:31.724113+00:00",
"id2": 22
}