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": "b165f82c-4a5f-45f4-85c8-43a3cb66ebce",
"_parent_id": "ff113038-1304-4226-8e9a-7fa0c205f7d8",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "72bcf316-45b7-4be0-9049-0334d20de2c6",
"company_id": "e2dd2dd5-6b37-44ee-a186-88c66c4cab85",
"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": "922ef357-31b3-4d07-9f57-72fa81fb99f7",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "cac8eaeb-e0b2-4a66-9ba6-d4ccb2cde776",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "fc54eedf-d92c-4ec2-bae0-54cc2c8ee9bc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "34af2563-60be-47dc-ba07-5accb1d8820f",
"company_code": "sample string 5",
"company": {
"id": "028286c1-d596-40cc-ba23-c579dcdadc9c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-11T19:50:09.9309315+00:00",
"sales_territory_id": "8994f944-cdad-4fae-bc9d-61f2ab68f70a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b22c9e33-cbbf-4645-b46a-89cc10e3a9b0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d61f17b4-f246-4fc8-a993-627fd9c544ae",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5ee3dbbd-83e6-41a4-8d8a-3887503fa8c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a442d87b-0745-48b3-8511-225ce4265780",
"db_currency_id": "44f1e054-551c-4ddc-b486-9a89ab2b34c9",
"db_language_id": "d68e7b6d-7728-4fa8-8f22-8697d25a84ac",
"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-11T19:50:09.9309315+00:00"
},
"modified_dateutc": "2026-09-11T19:50:09.9309315+00:00"
},
"marketing_segment_id": "c3f8064f-17bd-4228-a2ac-6b54e6f445a4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6064e9bb-ca0d-47b1-ad14-8d0c4f77cf2a",
"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": "78fb3761-5155-4371-98d2-d88431de4cae",
"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": "ccf950fc-fee7-47ea-aaee-d23ced13c472",
"db_country_code": "sample string 28",
"feelist_id": "05237024-619e-4e22-a13a-03a4ae29dee5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "26a9f41a-30dd-444e-ab21-40f6b52b5927",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8c28fa65-8899-4ab3-8865-3bf093d1ac91",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-11T19:50:09.9309315+00:00",
"db_currency_id": "15397cd6-43c6-4ff0-a791-d02b3761b1e2",
"db_currency_code": "sample string 10"
},
"company_type_id": "27c506f3-a4ad-4b02-917c-b9d09cdaacdb",
"company_type_name": "sample string 32",
"company_type": {
"id": "42072d99-deda-4554-a2b2-7fff5fba7d8e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bf8803dc-066b-42e3-b86c-c9b62b642c46",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6430f1f7-7e00-46ac-8e40-1c39ef502686",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9624e6c5-bc14-446c-a7f2-1922c4723dd8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4151bf9c-869c-4dc0-89a3-cd1deda12402",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b902e7b5-74fa-4249-8854-3ab4f89db465",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-11T19:50:09.9309315+00:00"
},
"company_sector_id": "629e3558-c9d6-489a-ab0a-4890305f9c27",
"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": "07c81e20-babc-4d49-92ee-72fa74e9eb9f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4054736c-bb8d-44bf-8b92-8740c0b53b05",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1390d833-e4d7-416c-b0a6-4aff87b218fa",
"account_manager_user_code": "sample string 56",
"company_status_id": "ef49aefe-7734-4d4c-a88a-475d68d1e0ef",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-11T19:50:09.9309315+00:00",
"id2": 60
},
"db_language_id": "97fbdf25-a86d-4199-bd76-5806155acae6",
"db_language_code": "sample string 7",
"db_title_id": "a09bf7f8-01ab-4687-bea9-275e16429cca",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-11T19:50:09.9309315+00:00",
"create_date": "2026-09-11T19:50:09.9309315+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-11T19:50:09.9309315+00:00"
},
"modified_dateutc": "2026-09-11T19:50:09.9309315+00:00",
"id2": 22
}