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": "a1cfd490-33a1-4515-8f92-2af468fd7483",
"_parent_id": "264293f1-6c92-4cf3-94ba-d10fcc6ede0c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2e993f15-f52d-4a1c-8014-e9ab765d9569",
"company_id": "7c03dac5-1b52-486f-8f92-79139f397cf9",
"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": "3f520f94-2828-4074-a2f9-b75e4f3abbf4",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "8dcea16a-58a9-4542-931c-59629657253f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6df7d6bf-041a-43da-990e-aa4425d9afcd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7cdaa0b2-5dc1-4f5c-afd2-d3be3c73094e",
"company_code": "sample string 5",
"company": {
"id": "059a1637-4398-416f-9ca3-2a4c9509c5cf",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-27T14:21:34.5496842+00:00",
"sales_territory_id": "47339b2a-6605-488c-bef3-335dd9709d25",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ba29c87d-2114-4901-a375-fca8c89d7425",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2fb7e0bc-c510-4cf9-88e1-b7aa9a2344f4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "01a36667-1a07-45fa-891c-24ac44e23a31",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "083aad0a-7708-407e-a25a-84efae27ef36",
"db_currency_id": "d79b6514-2f2d-47a0-920c-f524a03666ae",
"db_language_id": "baee06f1-5a71-4d6d-9fb2-8d80fe6ebdba",
"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": "2026-02-27T14:21:34.5496842+00:00"
},
"modified_dateutc": "2026-02-27T14:21:34.5496842+00:00"
},
"marketing_segment_id": "7474d939-c7c8-49af-8be9-0cd9f0263a49",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d97f9056-2d49-49dd-9a50-2ad7bf0025eb",
"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": "8ebea655-b70d-4ef4-a87c-5362b16a9b0d",
"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": "90c35e1e-f56f-4746-a09e-ccd2a440db2b",
"db_country_code": "sample string 28",
"feelist_id": "3bf7daa1-b12b-4753-a8d0-2992f49fc6e0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7c40fb11-ba81-4bc4-b208-68d09f863ecc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ba510685-1532-46e8-9d76-d71a99d6953e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-27T14:21:34.5496842+00:00",
"db_currency_id": "7defb5bf-d9d9-4209-97b6-3ae63790da19",
"db_currency_code": "sample string 10"
},
"company_type_id": "f17a441f-636e-4292-ab0c-80c1bd1dff96",
"company_type_name": "sample string 32",
"company_type": {
"id": "5d5e0733-29e9-4cf7-b87d-70bc9dd07e91",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "50a0a690-6f3f-40aa-9581-0a9bb3c7bc86",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6ebeadff-d0bb-4b75-8ab4-fdeeea771555",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "50b9a9c9-8fa9-4cd0-b366-f0cd21181236",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "706048e5-3ff1-4639-b121-b6bfdec70836",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "68dae921-f808-42e4-a0ca-5cae76e16882",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-27T14:21:34.5496842+00:00"
},
"company_sector_id": "8d3ea64c-8a1a-4e73-8fff-9238b3c9e721",
"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": "08b01bd1-4d92-4927-baf2-9c9afb6c0298",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cab8cb63-228d-4b0a-b334-900d5e8c0064",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3acf11ba-edce-4223-851f-119718edf383",
"account_manager_user_code": "sample string 56",
"company_status_id": "a7e487d8-e65b-4d91-9320-9a36c6c9fc5c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-27T14:21:34.5496842+00:00",
"id2": 60
},
"db_language_id": "9af9fbaa-a817-4846-964f-dfc4792631d0",
"db_language_code": "sample string 7",
"db_title_id": "41f3cbd3-2f6d-4e3a-9d58-7dbc4902b200",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-27T14:21:34.5496842+00:00",
"create_date": "2026-02-27T14:21:34.5496842+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": "2026-02-27T14:21:34.5496842+00:00"
},
"modified_dateutc": "2026-02-27T14:21:34.5496842+00:00",
"id2": 22
}