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": "aa124dd2-0b2d-4f78-8361-a4b184a9c2a6",
"_parent_id": "10127cbd-02f5-4457-8942-8b1927adcd93",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f35dc172-3977-4484-841e-4347df38fb2a",
"company_id": "af5cda85-4934-4ed5-8423-b37a2a16b7ed",
"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": "a047c7ae-0e45-43db-ab3c-fae80f1e1116",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "331b27a5-b43d-419c-bb22-91140f355adb",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "d9fae84d-6b43-4c11-b6bd-06582ab1c2d3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4d5bc140-1d82-4333-b86c-e9db50d30d4e",
"company_code": "sample string 5",
"company": {
"id": "7d39e5a8-84de-4111-bce5-28353a9b3bc2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-12T06:18:42.0449473+00:00",
"sales_territory_id": "dc1cf600-9465-419c-8600-90f6ce1f9e54",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e2d73b1c-43bf-4c50-98a4-7c881d3b1009",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5dea8330-4a77-4d7b-86a9-26da900fb238",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a202fa7f-9110-40f6-b9af-6aec61bb11a9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "692a0bee-bdf5-4f0b-b30d-fd0f92a0a2a0",
"db_currency_id": "a6a57870-b5f0-4c70-be10-2ce6d6d6442a",
"db_language_id": "87dc9a42-3a2e-476f-bf16-67a06efdff27",
"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-05-12T06:18:42.0449473+00:00"
},
"modified_dateutc": "2026-05-12T06:18:42.0449473+00:00"
},
"marketing_segment_id": "7d972682-8180-4bc6-a159-db435c108926",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6597626f-0c77-4880-b45f-0c0b16381660",
"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": "98245ce6-eefb-4186-9a3a-cda53fb85f80",
"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": "e58d7ad6-1c4d-4ee4-87cf-9909fc6f28a0",
"db_country_code": "sample string 28",
"feelist_id": "ea309115-8d3f-4971-884d-95163eea0712",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f422ce79-c73b-4b1b-9ccf-18eef59d0085",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ca059f11-2e13-457d-8183-628f2d3d661b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-12T06:18:42.0449473+00:00",
"db_currency_id": "9426d59a-7065-435d-8317-eba6a77615be",
"db_currency_code": "sample string 10"
},
"company_type_id": "77bee9a7-38f9-407e-a3aa-61cea26e1fed",
"company_type_name": "sample string 32",
"company_type": {
"id": "a0d76aea-36e5-4e81-a94a-46d4b86c9f6a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1adad7dd-dbc2-4081-8651-a7c6ccc62c84",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bbc61bd0-5c29-41c5-8cac-df40ba02adb0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a0e0c783-3ae7-48bc-86a1-b738bb5f234d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "71342a41-9d4b-4ae4-a3bc-8ce801dde8f4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3039d830-6d98-4425-ae78-30a5a60d03f0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-12T06:18:42.0449473+00:00"
},
"company_sector_id": "1afbedd2-e533-4274-b68e-6c62b1048bc3",
"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": "40ef5c75-f51a-40a9-b35e-a299a198ebdd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "966a58b4-774f-4b85-8721-8cc3c7e0902f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "632a6a9d-a031-4a91-9e52-5ba20217f0b9",
"account_manager_user_code": "sample string 56",
"company_status_id": "81552880-d55b-4917-9e84-96a836f05ac5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-12T06:18:42.0449473+00:00",
"id2": 60
},
"db_language_id": "bc5e561a-0c80-46c7-948d-3547198dab8b",
"db_language_code": "sample string 7",
"db_title_id": "4c6d466b-3472-4d5f-8e66-dcbb736dffa1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-12T06:18:42.0449473+00:00",
"create_date": "2026-05-12T06:18:42.0449473+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-05-12T06:18:42.0449473+00:00"
},
"modified_dateutc": "2026-05-12T06:18:42.0449473+00:00",
"id2": 22
}