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": "d1ed0bd6-d5b1-473b-a58c-4908f03b91cd",
"_parent_id": "c90a31db-f5de-4e5c-bc13-60a62b00719f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6ab002e4-46f9-4521-a50b-4885eae0ee1d",
"company_id": "c4863059-123d-4951-a85a-d790ae353467",
"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": "45898e0e-2a4e-48cc-b59f-98464d17646b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "7ccda740-8382-45f4-ac36-d5e0c77b0c77",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "27f5ac5d-13ac-48a0-947d-0c0098bfada5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "90ada28b-26de-4143-9a53-de1aac9ec885",
"company_code": "sample string 5",
"company": {
"id": "896b4170-3545-4cc5-b33e-546c273ea683",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-05T04:39:48.6471801+00:00",
"sales_territory_id": "4c36478d-bc8a-4cd7-8a54-ae0c16cdc0c6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5fee48e3-a640-4cf6-90c7-bbca0beb6a7b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "60219d7e-95c3-44a9-a521-134c4d1a8c43",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e6e3869b-9206-487b-a0fd-d41434853245",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a538330-54cb-4c96-9487-6ecc920a71db",
"db_currency_id": "daac18ff-bfdb-452b-9f5d-01b123107963",
"db_language_id": "02c0c081-9841-4701-a411-24a919aca014",
"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-03-05T04:39:48.6471801+00:00"
},
"modified_dateutc": "2026-03-05T04:39:48.6471801+00:00"
},
"marketing_segment_id": "6f58f7b2-9644-4cf2-8ff9-fd44058e0255",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c8d78b1c-a61b-4ccb-b3c5-4a70bcad2055",
"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": "dbba5dea-d9ed-4f79-b2a9-50ec8550029b",
"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": "0f75ce7c-f101-40c3-9556-0cdf69b862df",
"db_country_code": "sample string 28",
"feelist_id": "f4e407ac-a34f-417f-aa4c-27125e9cd68d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1186e7ef-e626-4f93-90e4-853132c16378",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fbee37b2-d597-4da5-b379-9fb7fb604fa3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-05T04:39:48.6471801+00:00",
"db_currency_id": "c9188e6d-ae7a-4128-a9e6-a129d465f1a1",
"db_currency_code": "sample string 10"
},
"company_type_id": "b2b8f01a-eead-416f-8764-97758a82725b",
"company_type_name": "sample string 32",
"company_type": {
"id": "3edd91bd-8803-4336-8805-152663675004",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9bccf3be-7fba-4385-b91c-2aad8d12218a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e531b3dd-1532-4a47-ad93-57423a0abaea",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e6f34ef1-4c29-4051-839d-c68fe1770bd5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "05f01434-11de-4ab1-85c1-0be6d2b55b23",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0d6f9b5e-1a5d-4278-9c44-ad9a53c5450d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-05T04:39:48.6471801+00:00"
},
"company_sector_id": "9140fa86-2959-40ae-a821-889e91eba264",
"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": "6d0cbb31-a383-4786-bbd2-b3edbf4a8629",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fb56aa70-d33b-4273-9cce-230104f8dc3b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ab26299b-e003-43f6-8911-838cb974e8cb",
"account_manager_user_code": "sample string 56",
"company_status_id": "8df318a1-3e32-4959-80f8-9b3f9e39d39e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-05T04:39:48.6471801+00:00",
"id2": 60
},
"db_language_id": "7ecd67af-08e9-4cdd-a8f4-a07ab67bdb49",
"db_language_code": "sample string 7",
"db_title_id": "1433a1c6-75ed-44ae-b2d0-ced7364d8f7e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-05T04:39:48.6471801+00:00",
"create_date": "2026-03-05T04:39:48.6471801+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-03-05T04:39:48.6471801+00:00"
},
"modified_dateutc": "2026-03-05T04:39:48.6471801+00:00",
"id2": 22
}