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": "f529d93e-a2fe-4cfc-86bb-1f081cb19911",
"_parent_id": "f398bd51-ecfa-4493-8c92-1c7b52052ab2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "940791c5-cf42-40c2-9d97-c25e879170cb",
"company_id": "4d7fc29e-4c42-480b-b254-680fb3da2260",
"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": "aec5a3a1-892e-4736-b120-1a7de2df2438",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e0acdc6d-0e58-43fb-a86d-12dcd29ccd9c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c149edbf-6d5a-4edb-ab58-f19c89418920",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e092a6c7-3287-4e5e-aa58-62e58b835bd5",
"company_code": "sample string 5",
"company": {
"id": "f34bde44-a4ac-4b08-be70-ec766b7a715e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-24T09:44:17.2278062+00:00",
"sales_territory_id": "c88ccd9a-3233-4af8-8ae5-26874c8b7412",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9b643f83-d8ff-4083-8b54-3075fd709a28",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7314b775-588c-44db-ab65-15bfd95525b5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5365ff9b-22f1-4b35-a61a-499c4e9a2ccf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "286689dd-4f16-4083-b87b-641384434da7",
"db_currency_id": "fe66c39f-2055-4d2e-9f1d-28fd0aee03fc",
"db_language_id": "b4b3cb8e-73b2-4e70-b38e-1f5ad721dfc5",
"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-24T09:44:17.2278062+00:00"
},
"modified_dateutc": "2026-05-24T09:44:17.2278062+00:00"
},
"marketing_segment_id": "1df29f20-8a60-422f-a034-3e2ca163ad75",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e32ca1b1-d2c5-4db3-b0c9-19bf9c2e7482",
"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": "73caa245-a87a-4bc3-a3dc-0bbefec0acce",
"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": "548f96f8-beea-4155-9a37-e110a0cf5035",
"db_country_code": "sample string 28",
"feelist_id": "405bd853-47ff-4be9-ba4b-907c6b3475cd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "48807cf4-8119-4d0b-9409-4b58fd1d94a7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cf8920a9-ea8e-45de-9c7a-b52990a2158d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-24T09:44:17.2434245+00:00",
"db_currency_id": "2dccb7d7-53dc-45cb-a0aa-4a012e915899",
"db_currency_code": "sample string 10"
},
"company_type_id": "7a37f769-8c87-480e-8ccc-e86cf55ba052",
"company_type_name": "sample string 32",
"company_type": {
"id": "6ec962d4-6629-45bd-9565-3b7f00d5f9e6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ffecd12d-9348-4c5c-b828-f121fc2a63b7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "04cd334f-444a-461a-8921-163742d92e63",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2a87bc44-557d-466d-b36e-6bc6152dba2a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "46355d33-aa7b-4a9c-a77c-888237216a1a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c9f9fe45-cae0-4548-aba0-1f5e06846647",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-24T09:44:17.2434245+00:00"
},
"company_sector_id": "907ef2ad-42b7-45a2-8d3f-296875e985d9",
"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": "b721cde9-0e8f-48ab-941b-079cd2db7781",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5b54921d-3018-46cd-ad48-716af01fbb53",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d3c0204e-197b-40c5-bcb8-b695390ea9d9",
"account_manager_user_code": "sample string 56",
"company_status_id": "4c6f10dc-9937-4d34-b319-5b91f1f30888",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-24T09:44:17.2434245+00:00",
"id2": 60
},
"db_language_id": "18604758-5814-41e6-893e-698938f8f705",
"db_language_code": "sample string 7",
"db_title_id": "cae29bfd-68f2-4a4a-86e3-ed27eb35d199",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-24T09:44:17.2434245+00:00",
"create_date": "2026-05-24T09:44:17.2434245+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-24T09:44:17.2434245+00:00"
},
"modified_dateutc": "2026-05-24T09:44:17.2434245+00:00",
"id2": 22
}