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": "267c72c9-2582-423b-b765-e285365e3ecf",
"_parent_id": "bd26680b-9b3e-49e1-a8f8-af73d81036d5",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e1a9f767-a859-4ae7-9aed-7a544085734b",
"company_id": "0b801249-81e5-4920-85ad-acac1f3ad443",
"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": "3aca608b-0f4f-4843-890e-87cffb84ec76",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ac4c68a5-18c1-4d27-a302-752e5a25f770",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ec6e01b4-0460-4e1a-8b2b-79096e529505",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e6f3efdc-a3aa-4a18-9f7a-65a602794e77",
"company_code": "sample string 5",
"company": {
"id": "7d806e65-9a69-4a6b-a4f2-f6e6967bafd4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-06T00:05:11.6755347+00:00",
"sales_territory_id": "213dc8ce-c474-4e65-82b3-7d25de64b5e6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a7a71d5e-8080-4728-a11c-0aa9890babca",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1a2c8ace-6b58-466c-869d-a8c7bab23031",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4a6e3a8e-38d1-4a69-9603-91bcdbfe4ba2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "332dc03c-184e-4e01-bb45-065d5aab7695",
"db_currency_id": "8253b732-1897-477d-87a2-d381aa082792",
"db_language_id": "8d15a5f9-dcec-44d9-b509-5c6b2b630e23",
"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-12-06T00:05:11.6755347+00:00"
},
"modified_dateutc": "2025-12-06T00:05:11.6755347+00:00"
},
"marketing_segment_id": "420c47d6-75b8-4b49-ab17-f37b2563b58f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "489a848b-ed93-40b5-8109-17fa276c8638",
"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": "bdbfdf59-6ef8-4508-92fa-cc78273870cf",
"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": "2adb9b6b-2a52-4a50-8ed5-f013dbe0bf1a",
"db_country_code": "sample string 28",
"feelist_id": "a2e92055-49c4-4c3d-9cc6-026439af7446",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fba47a0c-504e-451b-8cc2-266a4e49878d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "519e9f1f-0e36-4b99-8a63-f1a84136b94d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-06T00:05:11.6755347+00:00",
"db_currency_id": "cdde4bb4-63d6-4630-b2a1-667579d58e3d",
"db_currency_code": "sample string 10"
},
"company_type_id": "f6a5fe9d-95f1-4872-93d8-068c890566bc",
"company_type_name": "sample string 32",
"company_type": {
"id": "2e3b8aff-1e8b-430f-a4da-d6e5b190233f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "45adb25e-00d2-439e-8406-a432b99e20c4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3c6f1efa-8707-41c2-8b19-da4099e1815f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4155784d-ef0c-48ae-9a56-98455c02c6d2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c60605c0-e3f6-46f8-894c-d3726698cdd7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e00cb323-2a6c-4113-bc86-6c29275cc846",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-06T00:05:11.6911547+00:00"
},
"company_sector_id": "ad93ec68-204b-4743-93ff-1979306fa888",
"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": "5b4710c4-f8cd-4415-9867-f99dcbdbe9f0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "400036cf-b1e3-4f69-b5eb-02cc9a7950c4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d8f4f917-72b3-4838-abaa-d6c708a8589e",
"account_manager_user_code": "sample string 56",
"company_status_id": "ad6c0c1a-3a6e-4e3c-983e-550b2a35e4e9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-06T00:05:11.6911547+00:00",
"id2": 60
},
"db_language_id": "d2199bb0-9854-45fd-901e-58fb70c85928",
"db_language_code": "sample string 7",
"db_title_id": "27efb112-49d8-47bf-9b08-1495efc75ebc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-06T00:05:11.6911547+00:00",
"create_date": "2025-12-06T00:05:11.6911547+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-12-06T00:05:11.6911547+00:00"
},
"modified_dateutc": "2025-12-06T00:05:11.6911547+00:00",
"id2": 22
}