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": "11657738-84e5-4310-be58-84c743b869f9",
"_parent_id": "4d348079-ee11-466d-90e0-f68a9dec7f90",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ad4a3db2-48d8-4d95-a80d-ba43603c1690",
"company_id": "04f8785c-5342-4026-ac16-1c766fcc6d08",
"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": "53c4bf1b-1b5f-4fa9-ba54-388ddd2881c1",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "2d1f90d0-0f83-4d42-83ee-97fac6459ea2",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "b13b188b-9598-4d8d-bab0-214814dbea84",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5883dbb2-0837-46c4-8b0e-b5589c82e4d8",
"company_code": "sample string 5",
"company": {
"id": "42930eb1-a577-45eb-bdb1-997606d46673",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-28T22:46:14.9071203+00:00",
"sales_territory_id": "e7697645-0b90-444c-b14d-89abcef639b6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5faff984-5d78-4658-a594-55c901953e10",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "995ecdfe-b58a-4313-994c-531281ccfc65",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "486925fd-7046-493d-8fdd-76e99e1fe166",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aeb82451-4df9-4f7a-bf4e-ec86b0f16cbb",
"db_currency_id": "daf9e8d1-c43a-4cc3-83f4-6500b3707874",
"db_language_id": "12bffd8c-3362-4f53-bebf-d6a554c742ea",
"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-11-28T22:46:14.9071203+00:00"
},
"modified_dateutc": "2025-11-28T22:46:14.9071203+00:00"
},
"marketing_segment_id": "648b947a-3e7d-4718-a2d0-e11fae7a4d8e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a1f98d1b-c9ab-446a-afb2-0288962bc63b",
"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": "1ce9e443-26f0-4eb8-b188-863983c5ef2a",
"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": "b8f27e62-1d4e-41b0-8ba1-ad076f65ef7c",
"db_country_code": "sample string 28",
"feelist_id": "6628c919-a0d2-48bb-b114-a900be59353f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "687fd20c-23fe-40d2-93f1-89bf14789886",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5ea2ddd3-b0f9-4b81-bc58-6ef23de3aff5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-28T22:46:14.9071203+00:00",
"db_currency_id": "d9583a59-36a3-41bc-8b38-ecd9b0f87f19",
"db_currency_code": "sample string 10"
},
"company_type_id": "215ab015-98df-4d20-a906-9f60cf7e26e9",
"company_type_name": "sample string 32",
"company_type": {
"id": "fe8a2a87-9f2c-4747-b0e9-a6b4929c7792",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "251a3fd0-2aa5-4aef-9396-08c5024f035c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a9545bae-f57a-4756-bfb3-cc5a9dd63789",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2d5a0014-3519-4e59-979f-86e8f71a5c3c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c04d5b6f-d1bd-4262-ba59-ff82b7d2a837",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9d2b30b2-cdbf-4c21-8ed2-1be3c6ed5d8f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-28T22:46:14.9071203+00:00"
},
"company_sector_id": "21ca9bc1-1ce5-4f73-ab01-b73ef972ea9f",
"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": "4c08500b-36a2-4e9f-a711-d1b3f1906ab4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "67034d7b-7f0b-410f-a46c-f7e32078646f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a06ed43e-7b0d-47a4-b4be-301c33b8d7da",
"account_manager_user_code": "sample string 56",
"company_status_id": "35a50ab9-60cc-4ad7-8d47-730b4162e1ca",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-28T22:46:14.9071203+00:00",
"id2": 60
},
"db_language_id": "82b161b6-af32-4e01-8815-acdd9eb46318",
"db_language_code": "sample string 7",
"db_title_id": "883d3bac-7808-4c09-ad93-18afa360fbde",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-28T22:46:14.9071203+00:00",
"create_date": "2025-11-28T22:46:14.9071203+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-11-28T22:46:14.9071203+00:00"
},
"modified_dateutc": "2025-11-28T22:46:14.9071203+00:00",
"id2": 22
}