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": "d0e07474-214a-4b44-a181-9e4d1a8d44ab",
"_parent_id": "997c6084-ec24-4e71-8ea4-06d035859124",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ad202767-728a-487a-a46e-42a3b5db7577",
"company_id": "f1ece232-5820-4ead-9ebf-542c6f6d6bf6",
"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": "6731d3e2-255b-4a4b-9c07-ec6030865032",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "79906b3b-8834-426d-b17d-d7c1d73600ad",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "db3db16c-5d18-4a83-80e4-1e6c1d5c3138",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "82aabcdc-5d44-4056-a086-7bc2d5f1b2fa",
"company_code": "sample string 5",
"company": {
"id": "a4da9da7-a163-4ffe-9d70-daf29161d2de",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-02T03:48:52.3051803+00:00",
"sales_territory_id": "3a227fbe-57d3-441d-8882-dd056307900c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0bb0e588-bf27-4e3f-931d-550c78108edd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2e7403f1-3c27-4bc0-8381-bef1eca120d5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b1835ef9-fa4f-4234-bc8b-8d407b7107bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "661ea5ae-fa95-4204-ab56-95abe1b3d752",
"db_currency_id": "f15970ac-9f05-47ce-a871-5bcec5d6aea2",
"db_language_id": "212d3296-5ce7-4300-a82e-174b056deee2",
"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-06-02T03:48:52.3051803+00:00"
},
"modified_dateutc": "2026-06-02T03:48:52.3051803+00:00"
},
"marketing_segment_id": "adb30222-5fa2-476f-a214-ddd130b585d0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "12f3d3f9-47ee-41aa-ab50-dab4fcdc4323",
"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": "86be7d5f-4743-4198-bd76-cbf54e721f40",
"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": "d0d13c1f-c1a3-435e-a43f-0667ed245283",
"db_country_code": "sample string 28",
"feelist_id": "23d1509b-7ebb-4c50-ae83-37766bd8f3fc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9c9dc837-f03f-41e6-b2f5-3d278956650f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fa39ab15-acb8-4100-80f5-a4bf8b27fc87",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-02T03:48:52.3051803+00:00",
"db_currency_id": "074ce97e-4ab6-4014-9bc1-0ae76ecacfa2",
"db_currency_code": "sample string 10"
},
"company_type_id": "f8c694ff-7d69-4a05-908f-b9add378282e",
"company_type_name": "sample string 32",
"company_type": {
"id": "2c3cccc7-8a61-46df-9ef8-9b9478738a86",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "56f17cbf-9ec8-4c9c-b93d-1be6464860ab",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bf6ccde6-588a-4112-906a-b669097d52ee",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cb76f252-8487-4dcd-adfa-aef2a7212cdf",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4ddd7d0b-cdb4-463a-a31c-fedad77102a0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5af93443-11f0-4493-b191-e34515ffca50",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-02T03:48:52.3051803+00:00"
},
"company_sector_id": "5867a3b8-a8e0-4a72-9100-1a260e76c9fc",
"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": "913f0a9f-72c4-4b59-ad47-10b9650fdfba",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "19acd4a1-b0b8-48ad-9594-89bacf271974",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b39beb5c-f945-4b22-bbd0-08be90e295f2",
"account_manager_user_code": "sample string 56",
"company_status_id": "c7dd4f5d-f8b9-410e-a014-e1aa7e85f9d4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-02T03:48:52.3051803+00:00",
"id2": 60
},
"db_language_id": "af352d53-a1b9-4349-b3c2-89f57abe7f4a",
"db_language_code": "sample string 7",
"db_title_id": "5aa64ced-e2ee-46cc-8c80-81411920c8b1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-02T03:48:52.3051803+00:00",
"create_date": "2026-06-02T03:48:52.3051803+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-06-02T03:48:52.3051803+00:00"
},
"modified_dateutc": "2026-06-02T03:48:52.3051803+00:00",
"id2": 22
}