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": "9733f07d-162d-4ec4-865e-afafbc5c6292",
"_parent_id": "762a38e9-6fb8-4a5e-a798-d37dc57283d2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "5c07760c-9d95-4f44-86bd-eb8e0e4deb56",
"company_id": "c8ea0261-096b-4f8b-8ad6-a84054d8dee9",
"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": "294d7103-8b0e-4202-b5a2-0d6b15310d28",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "890a46d9-0788-495a-98d6-27cc86b85924",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "39b005e6-fb0f-4af5-a4c8-83ae26c91ac7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a17b518b-81a4-4976-a73c-dd87349675f4",
"company_code": "sample string 5",
"company": {
"id": "3085aa91-eba9-48b9-8303-36c90431eef5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-12T02:58:11.9661093+00:00",
"sales_territory_id": "49220e58-582d-4267-9085-136353c8b17d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9d0de871-c62e-467c-91c6-925fbcc7df2e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "536e9dea-b95a-4700-9935-0f3df9726005",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ef26221e-71f9-478d-8f22-72afdb8d4475",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "157ac99e-1d99-4cab-a21d-69b5d2ecfa51",
"db_currency_id": "10d573af-8441-411c-8d4d-3b9b29bb36b4",
"db_language_id": "b27cded7-d5fd-42b8-ae5a-166871d0c5e0",
"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-12T02:58:11.9661093+00:00"
},
"modified_dateutc": "2026-03-12T02:58:11.9661093+00:00"
},
"marketing_segment_id": "5bf1297e-b389-42f0-86f6-e6cf702818ec",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8a277215-c1b7-48f2-b06b-2188eb2dfb1e",
"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": "f57f572a-b311-43d7-8296-2a16e5d76128",
"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": "5d8479d8-b6b7-4b69-bcfb-e2e376b36500",
"db_country_code": "sample string 28",
"feelist_id": "49e01a6a-58e4-4a65-96fd-27cb009d7a19",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c726a3b8-0ab6-4950-a797-33b045e9e645",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "13bac9b9-cc92-45e3-91bc-7c96b9fc78ae",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-12T02:58:11.9661093+00:00",
"db_currency_id": "7d11e6fe-ea1b-4950-b930-656a30075fa0",
"db_currency_code": "sample string 10"
},
"company_type_id": "265e01d7-3e45-46dd-a79b-e87a495dc397",
"company_type_name": "sample string 32",
"company_type": {
"id": "04633f48-c950-4f83-adea-caa5c309250a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4e2304f2-8d55-4e58-98bf-af91985169c8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a4aff7bc-ee05-4065-b2a1-9e84bc90c8e1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3771e3c9-cdfc-47c1-ac1b-8233f78c5e1a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8eba1c0e-e135-4c27-bbf8-5b180ab667a8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "27de1a76-dc1a-47b1-958f-f3aed6d26657",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-12T02:58:11.9661093+00:00"
},
"company_sector_id": "2a065152-82cb-42bc-a046-3c6f2b020f68",
"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": "0dd52ec2-dfa0-4424-86ad-a28d81aa06c4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fb7e27b1-03ec-4cc7-add3-58378e68c88d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "26032623-5570-416a-9fda-0bd8b79e9c02",
"account_manager_user_code": "sample string 56",
"company_status_id": "beb7c57f-6013-466f-80c0-6a30b4568e5b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-12T02:58:11.9661093+00:00",
"id2": 60
},
"db_language_id": "635d18e4-b893-4d82-a7a0-33bca3cd17b4",
"db_language_code": "sample string 7",
"db_title_id": "93aa8bdc-e318-4e87-8c25-b683cc74257a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-12T02:58:11.9661093+00:00",
"create_date": "2026-03-12T02:58:11.9661093+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-12T02:58:11.9661093+00:00"
},
"modified_dateutc": "2026-03-12T02:58:11.9661093+00:00",
"id2": 22
}