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": "12aa0033-99f3-4b8e-af72-e9de2f7e0b70",
"_parent_id": "3fa99ba7-b38d-4ba4-be62-961a9820b0a0",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c3d0fa79-000c-4f01-9212-0284b25a5152",
"company_id": "153199d7-2767-4c08-831e-9e0985db11be",
"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": "6e6f2d07-55ce-446b-87cb-2f74742e9da1",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "929adcff-51d2-47fa-bd01-92dfd390d461",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6819aed8-24c0-4193-863c-c4065861c8fc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "67773aa9-5c6a-4c65-9a89-3db45dfda07a",
"company_code": "sample string 5",
"company": {
"id": "b72eedb4-070e-4c2d-9b69-76926c530664",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-16T18:21:37.1695075+00:00",
"sales_territory_id": "fa3aa5ac-5f66-4d81-9c8d-359ea4b0dbe6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9ddb19ca-8f7e-4e7e-b9bf-b43bc1dba899",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "45c9648f-686f-4e5e-90c3-b795823c205b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "94e5c8ae-8a0c-47e0-b6f2-55ad5ecf499b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "036894f4-0bc0-477e-b347-072e5f7671c3",
"db_currency_id": "1ed6dd03-2f67-4e56-a4f7-3f4e78747e07",
"db_language_id": "6cab47b1-022e-47bd-a123-9290726de6d0",
"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-10-16T18:21:37.1695075+00:00"
},
"modified_dateutc": "2026-10-16T18:21:37.1695075+00:00"
},
"marketing_segment_id": "f1db8bbe-0510-4b5b-a9d4-d879cccb7acc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e3adea3d-cbd6-42b7-8b4a-575b3e472d2b",
"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": "007ff6d6-5041-4745-a069-80af12fa7895",
"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": "ac027bb5-59ee-4310-a2e6-749ec68ae86c",
"db_country_code": "sample string 28",
"feelist_id": "7da2836a-6646-46b9-a1fa-9525f0318df1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e8cbe06a-5190-4345-97cf-ad790ee4f86e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c602c31d-481a-44fd-9c56-e06c3d99c8b9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-16T18:21:37.1695075+00:00",
"db_currency_id": "97cd7f6e-f51f-41a6-a1fb-e0423ce24538",
"db_currency_code": "sample string 10"
},
"company_type_id": "10668c57-7f18-43e5-b8ad-c2821e07dde9",
"company_type_name": "sample string 32",
"company_type": {
"id": "5ebc82d9-f902-4a3d-8d9f-f215a2cf7147",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8a54fe3c-65e2-42c7-9d40-ed37d42157e9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0b239c53-972d-4caf-ad12-467a0243fb20",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c78180fe-01f0-4aa0-8cc2-c748866ac32f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bc771bfa-0c6e-4ed7-84cf-cc7190252819",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8a5c86f4-fb4b-4295-a973-0fd89d2204fc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-16T18:21:37.1695075+00:00"
},
"company_sector_id": "1674bbe0-9f92-4d36-9c8d-7337a4581033",
"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": "eaf1f520-5b77-490d-93ea-9324b33e9d66",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e7c59c17-ad99-4b26-8f78-b71855af60ec",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8a435b15-4db3-48e7-9b68-9afbc72f9997",
"account_manager_user_code": "sample string 56",
"company_status_id": "324b1865-f111-423c-9904-44c37ab7447a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-16T18:21:37.1695075+00:00",
"id2": 60
},
"db_language_id": "fab9b6ca-15ba-4d4f-8320-007cb0f1454c",
"db_language_code": "sample string 7",
"db_title_id": "9f53eeef-44e0-43bd-ada3-8c81db9abc61",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-16T18:21:37.1695075+00:00",
"create_date": "2026-10-16T18:21:37.1695075+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-10-16T18:21:37.1864246+00:00"
},
"modified_dateutc": "2026-10-16T18:21:37.1864246+00:00",
"id2": 22
}