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": "f76882f1-4d51-4f18-ab20-9ea2bf9a575a",
"_parent_id": "218369b5-cb65-41ee-874f-603dc77687a9",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "50e66a38-fb80-46cc-993e-699356c21a09",
"company_id": "d034d3a0-4d12-493b-9881-13148a393c1c",
"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": "a0214cce-256a-473b-a59b-3b12824034db",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "fd60c718-d9e1-467c-a82d-49e5379254be",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "21b5a516-3ade-4434-a323-fc6bff9db1f8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "02166b41-5721-4a65-9cc6-0e32b48b24e9",
"company_code": "sample string 5",
"company": {
"id": "1e05fcb2-6820-4afd-a9e5-f611578e540e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-12T12:34:56.7297271+00:00",
"sales_territory_id": "18564989-fb41-4505-9450-31a903231cf4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "55a1d988-2f3b-4230-8be9-331318a84efc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0d7f9b79-51ca-4478-b47c-5049cdaf277f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "20d89fea-10f8-483e-9ff4-1e9145ca56d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61a856b5-f33a-4d52-ac95-5efd9c052f44",
"db_currency_id": "224755f3-ed11-4c4d-9cfc-496b7da24099",
"db_language_id": "e5bf3012-9956-4c58-a831-77f346f49553",
"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-08-12T12:34:56.7297271+00:00"
},
"modified_dateutc": "2025-08-12T12:34:56.7297271+00:00"
},
"marketing_segment_id": "dac1c1ec-6cb8-41f2-8f48-1b37c09feaf7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2aab6044-0cdd-4f0b-84ac-e5d1ed2a3429",
"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": "97d85937-8403-4fc4-a128-02db19141bd7",
"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": "83e74335-78c1-4e3f-9967-4765f370fa20",
"db_country_code": "sample string 28",
"feelist_id": "b0c0e299-6435-44fc-9ca3-69e486c94cc3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fd90ce05-2579-4689-a43e-10893c8137c3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3e7f1cb4-8ac8-4ac2-8302-bb7f555f8803",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-12T12:34:56.7297271+00:00",
"db_currency_id": "95b7347d-8a6e-43fe-bd5d-273965fbf8c4",
"db_currency_code": "sample string 10"
},
"company_type_id": "d8c56e20-084e-4b9b-b7b2-ffa0dba407e0",
"company_type_name": "sample string 32",
"company_type": {
"id": "e46035db-8567-48de-a285-0b034a734edb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "60a5a466-6c63-4249-b3aa-4f4e1f58c289",
"sales_organization_code": "sample string 5"
},
"db_language_id": "259a7b0b-d8d7-4db2-baf8-66fb6d202922",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e8927511-b655-405d-8643-60efc4bc0bc2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5fb10739-850b-494f-92a0-d61ed0325fe1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1b13ef7c-5537-4adb-ac9f-8c900bc8d99c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-12T12:34:56.7297271+00:00"
},
"company_sector_id": "b94d740d-c1dd-4edf-8946-71ebd178074b",
"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": "66058f78-f253-403a-9822-e0df908be970",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3ea2d020-11a8-47f2-b3c3-1b27bcf6f1d3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "93749442-767d-44d5-9d5c-c3b1867b0167",
"account_manager_user_code": "sample string 56",
"company_status_id": "f465047a-f455-4334-9db5-c3b5f975c4b9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-12T12:34:56.7297271+00:00",
"id2": 60
},
"db_language_id": "6ff854b4-4290-475b-b930-6b1d41da1106",
"db_language_code": "sample string 7",
"db_title_id": "eace571e-677d-4576-97b1-b47299191bb9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-12T12:34:56.7297271+00:00",
"create_date": "2025-08-12T12:34:56.7297271+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-08-12T12:34:56.7297271+00:00"
},
"modified_dateutc": "2025-08-12T12:34:56.7297271+00:00",
"id2": 22
}