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": "93aabfc9-bfd4-4b13-a1aa-3095d91bfbdf",
"_parent_id": "29b38118-12e7-4352-9099-8fb424458f5f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "43b72dca-23c7-46b0-85ec-9e7f0a1bf676",
"company_id": "2c800180-0680-484f-8687-cd57cafff4ff",
"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": "9d1f1559-6e6e-4485-98d3-363815a911e7",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "94b73bc8-d370-4b40-91f2-4feb33573b13",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4f186390-0a57-4930-b9e2-60b766a369b2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "507f7d66-d017-43d2-9d71-e4a314a28206",
"company_code": "sample string 5",
"company": {
"id": "96eaf545-e0e2-42ca-85d2-e67cb9d8549a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-23T20:48:21.9610358+00:00",
"sales_territory_id": "9464a99f-fe3d-4eab-b70b-1a3c71ab06e1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c0eeebdd-380c-4b52-86c9-99027c41509d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6299527f-8fb8-45f3-951a-a7ed5a386dce",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cf025683-db64-48b4-94c5-9da3dc9614d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaddeafb-5089-4717-9d44-9f1f9c164768",
"db_currency_id": "5e4c8658-af82-4aa8-bf86-af6f7d94a898",
"db_language_id": "01a292f1-45d5-4911-bc73-609c20d99106",
"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-23T20:48:21.9610358+00:00"
},
"modified_dateutc": "2025-12-23T20:48:21.9610358+00:00"
},
"marketing_segment_id": "09993e2c-8d4d-4b13-80e3-cf25017e75f1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a3406079-0bbd-404d-8bd1-a1c4c7399763",
"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": "1e4464d5-edf2-4ffd-83f7-9a532117e682",
"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": "6e63c8e2-cf64-4e0c-8b83-23b8e5853280",
"db_country_code": "sample string 28",
"feelist_id": "5ba0b2fe-ed24-4373-9bdc-818d6463207b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "80a03256-3c55-41f4-8b86-d4529837fc2d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "65076e84-9a79-4fb7-87da-c41322d5c39a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-23T20:48:21.9610358+00:00",
"db_currency_id": "89388535-28c4-48d4-9d8a-4610b27e6cce",
"db_currency_code": "sample string 10"
},
"company_type_id": "43f37948-4687-4a8a-ad33-cfc05de589c0",
"company_type_name": "sample string 32",
"company_type": {
"id": "2701d035-572c-4d27-99f0-5c232fe5b32a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c5bf7fd7-4d91-4eb8-8d72-7353d25ae65d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "de361f71-357f-4156-b325-772647523237",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2ddd9b5a-be7e-486a-ae24-b9a3aa6eba1d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ee842278-3a9b-4d7c-b2cc-3923c742e29b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7d3abab3-87f3-45ac-9033-924d40c20b1c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-23T20:48:21.9610358+00:00"
},
"company_sector_id": "1ddcc81b-ab38-45d6-83be-d3a71315ae62",
"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": "0304b5d7-6ca0-46b0-bd44-156ec0e70e92",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5336ef8a-48b8-4fac-91a0-34e3088a3c6e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f833e02c-8e7e-47a4-93e8-df87cbf46451",
"account_manager_user_code": "sample string 56",
"company_status_id": "6fe6c0c3-6d6b-4aff-8a22-90c6536e8f57",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-23T20:48:21.9610358+00:00",
"id2": 60
},
"db_language_id": "21256592-3a67-48cd-8e75-dd53abc75351",
"db_language_code": "sample string 7",
"db_title_id": "eefc61d0-a6f0-426a-a042-e0baf4b0facc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-23T20:48:21.9610358+00:00",
"create_date": "2025-12-23T20:48:21.9610358+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-23T20:48:21.9610358+00:00"
},
"modified_dateutc": "2025-12-23T20:48:21.9610358+00:00",
"id2": 22
}