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": "15373de1-bb73-4aa2-963e-42eba31b9586",
"_parent_id": "4786ea15-fc3c-463d-afff-02d8db5a9305",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "573970e3-9df4-48fb-a6c4-895c3f15ad2f",
"company_id": "cb5cb176-85f9-48c3-8a60-13eacaebf885",
"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": "79926d2a-bbb9-4026-9c3a-3e9b42d2bd2c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ddd6420a-f786-4562-a43e-1c73a00e2378",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "732b4598-2c8d-4c94-b161-8d638521e676",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "162cca4e-4159-4e22-bdc0-cebf20ef0b0c",
"company_code": "sample string 5",
"company": {
"id": "5188ab79-7efb-4445-9bf4-b0f70a017fc1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-07T21:54:58.2134663+00:00",
"sales_territory_id": "f10dd1e4-ea16-4ee2-b0a5-e12772ee45b0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d7e8be94-7190-410a-a2e8-90fb323f19b0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d17d024a-9414-4c4c-a748-d0a69d7fda7b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fdaa177a-160e-4bea-9265-fe248c9163eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef27a43e-58c6-4ec7-ab1f-c6b3fdffb0f8",
"db_currency_id": "bcbc5fa1-34e7-4642-91ff-5d3b39193f25",
"db_language_id": "ea226cf3-94b5-42af-9633-e78374f54f84",
"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-01-07T21:54:58.2134663+00:00"
},
"modified_dateutc": "2026-01-07T21:54:58.2134663+00:00"
},
"marketing_segment_id": "517bcbf5-1d47-4abe-8e5d-89d5ae9da4fe",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d92972f8-1ea3-4a88-aff4-ed44375b88da",
"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": "4c31cc12-32f5-40b5-853f-bc5864776787",
"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": "1dfd4a1d-31a8-4c78-98a8-4a93559ebdbc",
"db_country_code": "sample string 28",
"feelist_id": "5c962bfc-363c-441c-9a93-70bc198438f9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9017dce8-fbf2-4211-9d95-d82feb1ab6cc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c0771a65-fd80-4c1e-b0a7-a98921dc784e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-07T21:54:58.2290914+00:00",
"db_currency_id": "e5008887-ec4e-440d-9f3a-a04aef77c415",
"db_currency_code": "sample string 10"
},
"company_type_id": "6ebe13c3-2809-4ae5-9ff8-19544d1f4614",
"company_type_name": "sample string 32",
"company_type": {
"id": "5696db27-b1a2-47f3-9a27-40a64479894e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eed70563-5b9a-4e2d-aa0e-ac13eca41439",
"sales_organization_code": "sample string 5"
},
"db_language_id": "47d0a1d9-83e9-4524-91ff-13e3bab90893",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7d272846-a69d-47c0-8cc2-eb8b35f6ac5a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c8f8d910-192b-4ff1-a977-9c5c6ffab264",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "732ee35c-daee-4dd1-a4b1-c20f27be4c47",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-07T21:54:58.2290914+00:00"
},
"company_sector_id": "cfa58e27-5d72-4aff-9dc3-c312e5f09f7e",
"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": "23b8a444-8971-4a7f-8b22-a482c85fa748",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4381592b-e2ec-48e9-a7ee-a10838c25fae",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "883738dd-51c1-4682-ae96-ed1e57db4fb8",
"account_manager_user_code": "sample string 56",
"company_status_id": "b1434658-9f30-4806-a492-125f618b31d5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-07T21:54:58.2290914+00:00",
"id2": 60
},
"db_language_id": "d4277909-8ba1-4f8b-a013-453de1a8ba88",
"db_language_code": "sample string 7",
"db_title_id": "f3ecbe89-2405-4b09-b383-8f300de1a5be",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-07T21:54:58.2290914+00:00",
"create_date": "2026-01-07T21:54:58.2290914+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-01-07T21:54:58.2290914+00:00"
},
"modified_dateutc": "2026-01-07T21:54:58.2290914+00:00",
"id2": 22
}