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": "d5c73c77-4c59-473a-9d69-bf087c6ec18d",
"_parent_id": "a674da5b-fd36-4918-b24a-344bee9090c3",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b5bce889-7221-4b69-b6c7-8d5eafe41a5d",
"company_id": "d610814c-fae3-465e-80d4-308d3992eb2c",
"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": "252618c0-d0c8-424a-be44-601ca997103d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "aebee3bc-fad0-4340-a57f-db7eca99edb0",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a2b78c95-aec0-4cfb-ac53-37338af71171",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "47e90a98-89fb-496f-8ecc-671310ce91d2",
"company_code": "sample string 5",
"company": {
"id": "e17d6711-1340-4dd8-9a7f-b2f7c1263df9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-22T04:00:57.0969055+00:00",
"sales_territory_id": "a747e01a-a161-4532-81d8-22a8c18dcafb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6739d24d-6234-426e-8270-14bbbf0fd7bd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1cd3a53d-54b6-4e88-aa1b-0537ff7cf00a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "87b7f3c8-92a9-4eb1-8f9d-fbd3fe81ee09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ade9fb9-f8e6-481a-91b4-d738298b531b",
"db_currency_id": "4fa5919e-a9df-4576-98c1-eff0a6a0ced1",
"db_language_id": "76e06cdb-02bf-49f2-93c5-3572d3c84abe",
"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": "2025-11-22T04:00:57.1125304+00:00"
},
"modified_dateutc": "2025-11-22T04:00:57.1125304+00:00"
},
"marketing_segment_id": "ad77449b-0c8a-4aa4-b1a5-cb1f556f7b64",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "73f63f8c-2641-4959-91ea-d4b61821e912",
"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": "c8424b3c-b192-4e8e-b902-b6485401559e",
"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": "cb797acd-4ce7-413e-90c9-1cc7d6f8d382",
"db_country_code": "sample string 28",
"feelist_id": "58a3a114-3f0a-4b8b-a3f9-f97e176c0aeb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "614f139e-452b-473c-a0a7-f581a517fb70",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "734224bb-c83f-434d-8745-428dc8f42f92",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-22T04:00:57.1125304+00:00",
"db_currency_id": "95075640-c4b9-4b51-b3d8-efc4a7173745",
"db_currency_code": "sample string 10"
},
"company_type_id": "a7472972-bc30-4b40-9140-53138ed3fb7e",
"company_type_name": "sample string 32",
"company_type": {
"id": "689ac822-1464-4b91-81b4-128b78142449",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "06f9e530-ed8f-4190-a98c-a0a8e485a7e5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "af83902a-9c48-4d9c-ac40-b4a3d952f50e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f3d40ab6-bcc5-42b2-877a-13bcdc4d1704",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "58d02e6c-f913-4a1e-b679-24ccbf5449cd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "65a6469c-e86d-4a65-a6ea-f4bc8630da24",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-22T04:00:57.1125304+00:00"
},
"company_sector_id": "ea2ac220-3476-4228-bb14-50fe016c8dab",
"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": "c9eca090-72ff-48f5-90c1-56f5c7204f80",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "670f7060-89de-4bfd-a538-3730c2a5ec8e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d1402d5d-5a9b-4bbd-acd8-260f81f40b79",
"account_manager_user_code": "sample string 56",
"company_status_id": "b9fab108-6b9f-4d70-9fb6-72d692013604",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-22T04:00:57.1125304+00:00",
"id2": 60
},
"db_language_id": "cd0776d2-1eab-4988-9104-a96fed82f1c2",
"db_language_code": "sample string 7",
"db_title_id": "1b433c97-e2ab-45db-b277-c08277cb7426",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-22T04:00:57.1125304+00:00",
"create_date": "2025-11-22T04:00:57.1125304+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": "2025-11-22T04:00:57.1125304+00:00"
},
"modified_dateutc": "2025-11-22T04:00:57.1125304+00:00",
"id2": 22
}