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": "53caccce-9be0-4837-9e25-60236dc9ec50",
"_parent_id": "1f30ca18-9fda-474f-b3c6-9282d1fdb31f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "556bfd17-e9d3-453e-9bc1-13360ed74e33",
"company_id": "1e32a813-9e74-4bf0-a7e0-039bf91ff044",
"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": "cabe3a7f-ccb7-4dc4-87ca-b3f7bea733a6",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "bb2b3452-b241-4434-a127-726d4723180f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "499a8082-f81b-40a0-992f-8603b20e9712",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f0546f82-7e4a-4886-9882-a799964147cb",
"company_code": "sample string 5",
"company": {
"id": "210561d0-6436-4e9b-9a2b-cb94879f16c9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-07T21:05:05.6707222+00:00",
"sales_territory_id": "e708c54c-ce0e-4f12-9d99-3e6e582af14b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "67ccf359-f2e4-463b-a98c-08fff62b5d5e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "358ff360-c6db-41ab-a772-04de2019185c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "84ac2443-ec21-4a23-b713-362d07c20dd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "328e6a28-4320-442c-9751-94c885e57074",
"db_currency_id": "ab4a0791-6132-4c90-986f-43b113151b4b",
"db_language_id": "9b9e0184-c16a-477a-9615-6f4c0e22bbf5",
"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-05-07T21:05:05.6707222+00:00"
},
"modified_dateutc": "2026-05-07T21:05:05.6707222+00:00"
},
"marketing_segment_id": "9efdad36-1fcc-45e2-bfd4-1d8d1e363507",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bb56f2e3-725f-4295-a9ff-6adf76d61326",
"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": "32d336bb-2c65-40b4-ab21-1df259bf2650",
"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": "140e1865-5f4c-4061-8525-ca9f0b6fe151",
"db_country_code": "sample string 28",
"feelist_id": "ac7d5542-5951-4875-a244-4bd748ea83b2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9f040fb8-9a9a-41b7-bc8a-b270f7d49b1b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "868b6b06-c4c9-490e-898c-aaa46bbc68e9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-07T21:05:05.6707222+00:00",
"db_currency_id": "89f3ae88-ad48-45cf-aacc-c39b4e48cb9d",
"db_currency_code": "sample string 10"
},
"company_type_id": "667e9da8-3dda-45b4-b21c-0d8cd092a12a",
"company_type_name": "sample string 32",
"company_type": {
"id": "dc5b1794-3c38-40cf-8b9a-b0e1a62b464a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d6b7e78e-375e-40b9-b6e7-a181d602f90c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "51bd6ede-fd10-45b2-91f2-bb1a1db7e92e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9d0e332a-c7c9-4623-a3e1-e97e6de85c6d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ae8440f0-87d9-4901-b6ed-f8cc693c6ccb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b3c1fb32-44fb-4b5e-bab3-7e5e58f11b53",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-07T21:05:05.6707222+00:00"
},
"company_sector_id": "1628c4aa-3c28-48c0-9222-8e77c85f2f21",
"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": "9699ae92-6639-4134-b7c2-9d604eed1ed2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "878a7316-4aab-4982-9ecc-f786edf54131",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "faa07316-eaa4-47ea-94f7-e56c1757ce0f",
"account_manager_user_code": "sample string 56",
"company_status_id": "eab2d426-38cb-4ff4-864e-f79339c89fee",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-07T21:05:05.6707222+00:00",
"id2": 60
},
"db_language_id": "7ac91268-974f-40fc-b1d2-73702c243fba",
"db_language_code": "sample string 7",
"db_title_id": "fa21068a-08ed-4b8d-a780-ea457c42c465",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-07T21:05:05.6707222+00:00",
"create_date": "2026-05-07T21:05:05.6707222+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-05-07T21:05:05.6707222+00:00"
},
"modified_dateutc": "2026-05-07T21:05:05.6707222+00:00",
"id2": 22
}