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": "75b760e3-fd42-47c3-8306-86d0022eb9b2",
"_parent_id": "4abd385d-68ab-4f94-886f-29a1e39fcd94",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "d19f5b4b-ddde-4201-a7cf-f501ff5d8131",
"company_id": "09a5e38a-b137-4f18-b839-880265983809",
"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": "c9845749-eca4-466f-bbb5-a31aebe0089f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "936895a3-d940-4ebe-b9a7-340bdab94ebb",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "767e8ca0-018a-466e-ad84-5d6733d07a86",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "be2f0885-9e07-4e58-9b0b-9cab64cee8bb",
"company_code": "sample string 5",
"company": {
"id": "a39990b7-4008-4ef7-9044-51383fa3f146",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-08T14:30:49.5079976+00:00",
"sales_territory_id": "55026e7f-9328-41df-b86f-a7b5c2de69dd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "07503c47-8958-451c-be4e-71e47f5a0a3e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "85a5fd40-1459-4d1d-ad8b-0b69bafc2fda",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9d7d14b8-768d-41a7-ba8f-9426f36bfb3a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b19588ff-2cad-4e5e-bc5b-401a0cb9b925",
"db_currency_id": "3d6cfcd0-8dec-4d5d-b369-547894119b9c",
"db_language_id": "51fa1c9f-ca28-4c3f-976a-ee262f66b990",
"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-08T14:30:49.5079976+00:00"
},
"modified_dateutc": "2025-11-08T14:30:49.5079976+00:00"
},
"marketing_segment_id": "94d73390-777e-417a-b8e9-2b2ba2da8b03",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f5128dac-87c6-441f-bcb1-5e28184a6a6b",
"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": "de30f8f7-edd7-4a78-8368-94ad8dfa5a69",
"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": "4e2e4ea6-9073-4473-99be-3ad3d790504c",
"db_country_code": "sample string 28",
"feelist_id": "6a97e2aa-6502-45e0-8f73-b17742eda195",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a9924fae-fb07-40a7-9bca-3a78a1d725fb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8c24fe5f-e004-4227-aa05-85b6a1d2574b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-08T14:30:49.5079976+00:00",
"db_currency_id": "49846d99-12b8-4f6f-ab70-6e55f8a8260f",
"db_currency_code": "sample string 10"
},
"company_type_id": "d96b3ad8-3aba-4c84-8773-e1c0732ce107",
"company_type_name": "sample string 32",
"company_type": {
"id": "0ea5c23c-d947-438d-a343-5d77f2f92951",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "df5a53f2-da37-4216-8008-0e5cdbe44ef1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "dafbc101-1bb5-4748-9164-0e91ae97d140",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "298884cd-e69b-4ef9-b0c7-b52c4af611ea",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fdfe6c66-5c9d-4798-8ef2-99c31eb751c1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "62a49196-f861-487b-8156-ee45c64353c7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-08T14:30:49.5079976+00:00"
},
"company_sector_id": "e76a738a-aa31-4043-b975-6fed202e5085",
"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": "5c3ba72c-dbc6-425e-a944-36bb04d449c5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fcbe6186-d158-4a14-a86b-2b78ee894df4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "86d232df-62fc-4303-9482-b61a71cf6620",
"account_manager_user_code": "sample string 56",
"company_status_id": "bd2a6611-12ad-41ec-a5f3-e1865b7218c3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-08T14:30:49.5079976+00:00",
"id2": 60
},
"db_language_id": "c1dfe7ca-1264-4a55-bb5a-88375f1e088a",
"db_language_code": "sample string 7",
"db_title_id": "d4bf8d73-b94c-4d40-86ee-a297c7f208ff",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-08T14:30:49.5079976+00:00",
"create_date": "2025-11-08T14:30:49.5079976+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-08T14:30:49.5079976+00:00"
},
"modified_dateutc": "2025-11-08T14:30:49.5079976+00:00",
"id2": 22
}