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": "62f5fd7c-ff8d-4966-9178-7cfe04706943",
"_parent_id": "88e0cf2b-f114-419e-bf46-58b6838a6ea5",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "85a42b4b-ec58-48b5-b59e-6ffa7e5a66b5",
"company_id": "f5cdf941-e0b4-4ad7-9355-69c32ffedb2b",
"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": "74eb173b-6427-45b2-864c-c6e54e6a23b6",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "87acf0d2-9ebc-4d85-80e6-5863d21971c1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f594ee39-7359-4bc0-93f0-533103232b6d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dc6ef7b8-9dd1-4bef-814d-fefaa0b59916",
"company_code": "sample string 5",
"company": {
"id": "14f033eb-b694-4e7d-9643-59b97fbdb8d3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-14T23:25:51.7156899+00:00",
"sales_territory_id": "303db256-e996-4add-bbfb-fc2c6d5b966f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "abb85e54-ea3d-4767-8150-9948ae1c4e01",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "07f0053b-a9a1-44ad-b04e-e136d9fb2f19",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cc40a36d-9888-4ef8-91ce-f3555785dd5b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63e6fb3a-1554-477b-aee8-0b584b61ae87",
"db_currency_id": "f885ca87-1d79-41bf-9cc8-8cd17336ba5a",
"db_language_id": "a99f959d-c1c7-4551-87bb-26b531e9cdbe",
"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-14T23:25:51.7156899+00:00"
},
"modified_dateutc": "2025-11-14T23:25:51.7156899+00:00"
},
"marketing_segment_id": "0a5887f7-42d6-4348-842e-1c5cbecb877b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5a6923f9-fcc6-4010-9835-d06dc85ca6c6",
"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": "6a0b135d-317b-40d0-b546-607572720a75",
"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": "23e302e7-6d59-49b4-bd7f-c4e2b3da4cf4",
"db_country_code": "sample string 28",
"feelist_id": "d4700d78-5034-4dd9-92c1-76317bdc359a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3f1efc04-6a99-4ad2-b1f4-cb473c68dabf",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "efceab21-be73-47f3-bea9-2b78b3ab3a09",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-14T23:25:51.7156899+00:00",
"db_currency_id": "f3f87076-0911-41ae-9d22-711c4b99f9bd",
"db_currency_code": "sample string 10"
},
"company_type_id": "7e7e9f9e-597f-4f49-bcf3-57ea00a1f5f3",
"company_type_name": "sample string 32",
"company_type": {
"id": "cd73faf5-84f7-402c-8c20-34d9f8669071",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fb3a8343-48fa-43e9-ad4b-483e4084c68c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "54b197d5-3c72-4b45-a521-6c4e45e9a520",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "39baf868-9e0e-4523-915f-df795431671f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "efb21710-e1bb-413f-8cfd-89c888ccdda8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2fe20960-6b79-46c7-b2e6-bb8bfb4acbf3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-14T23:25:51.7156899+00:00"
},
"company_sector_id": "bf4e3095-f256-40ef-a52a-119f00dac36e",
"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": "08a5174d-5969-4aa2-a0ed-b9353efd0f0d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c7f7666c-6a9e-4d06-a5c7-16c47cf26b8b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f748c83d-a0b1-41a6-9e3a-49ff1d711fe8",
"account_manager_user_code": "sample string 56",
"company_status_id": "479191bc-58a1-4631-9fc3-f3a20f715494",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-14T23:25:51.7156899+00:00",
"id2": 60
},
"db_language_id": "f78a7967-bcc4-44c5-ad71-f4ea4ec894bc",
"db_language_code": "sample string 7",
"db_title_id": "f3b52ddd-4a5e-4941-b1f9-3de048a2f5f5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-14T23:25:51.7156899+00:00",
"create_date": "2025-11-14T23:25:51.7156899+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-14T23:25:51.7156899+00:00"
},
"modified_dateutc": "2025-11-14T23:25:51.7156899+00:00",
"id2": 22
}