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": "a09a5d1e-58a1-4f19-a76a-b3983ccfa1ff",
"_parent_id": "340291f4-4209-456e-8eec-2af3b1391478",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e400e51c-7e4d-426d-8a4f-59278461887a",
"company_id": "bed636a5-5bbf-48b5-a287-34c81205f763",
"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": "94d30984-3bf8-4dcd-b853-8fbd848837b6",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "578c6d11-5957-4641-84e6-2b286f697d30",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6dbea269-a76f-4eb9-9b76-662afb4c14c4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1daad588-b23c-49ab-b26b-c60f5cd50819",
"company_code": "sample string 5",
"company": {
"id": "17f7d490-b189-430d-8078-50dbdbd53a82",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-08T19:25:37.1801038+00:00",
"sales_territory_id": "e78123cd-b953-4701-8642-1b25e166eb36",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d1ad87b0-1b15-47d8-bb4d-edb0ccb6958f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c85d095d-eedd-434e-8612-19cd00e02d84",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "01a2e7f1-56f7-47f2-ad7b-119f76eaf5a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bd7760f-124f-4218-a6dc-a67eaf205096",
"db_currency_id": "86677812-7541-4830-9194-a2b34b7e10d1",
"db_language_id": "7aec9f86-b340-4a74-91a8-5bc84e00b08d",
"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-10-08T19:25:37.1801038+00:00"
},
"modified_dateutc": "2025-10-08T19:25:37.1801038+00:00"
},
"marketing_segment_id": "73410355-188b-4d59-bc43-cd8588a9891c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f53f0281-f070-4470-8a09-40b86ee8df9b",
"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": "814f05a9-d791-42fc-b2ee-63e249413b71",
"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": "67fa2016-9a1a-4078-aa64-c02d903ca4de",
"db_country_code": "sample string 28",
"feelist_id": "9a66a04f-fccf-4b68-9f46-22b40c50baa0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6b4f9a6a-9592-44af-9cce-7e37a5a18bfc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c015b54f-6df2-468c-846d-c5a74488d701",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-08T19:25:37.1801038+00:00",
"db_currency_id": "d90ad649-fed5-45fc-9fb7-dd5bff76fce8",
"db_currency_code": "sample string 10"
},
"company_type_id": "5022803e-19fb-46b8-985a-fdcdf4c824cf",
"company_type_name": "sample string 32",
"company_type": {
"id": "da33abd2-711e-47ec-ae1a-bd546b5eb69a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f04d5a80-e821-4db4-9dc3-0fd9c18cb856",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4fff6da3-388d-422b-8aa2-e2f770664fb7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4733707e-6525-4129-b69a-3b515f4bb984",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1c7e547f-e9d1-4eae-bcbe-bc36cee5b455",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6888cad3-7f64-4dec-aaf0-c83edf4ec8e6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-08T19:25:37.1801038+00:00"
},
"company_sector_id": "3837e17a-e6a9-4b8e-ac8b-ec83d748f1fb",
"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": "6dde7ce3-bb10-4644-9734-916f609d8a70",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "194ca1cf-cde6-448d-a9fb-f55bbf4c3202",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7575c935-e4ac-443a-8055-bee04228530b",
"account_manager_user_code": "sample string 56",
"company_status_id": "a12c71e5-f527-43a8-b4d0-a00d52e0db18",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-08T19:25:37.1801038+00:00",
"id2": 60
},
"db_language_id": "cf20fda5-2d47-4fbf-a58a-642b97719dc7",
"db_language_code": "sample string 7",
"db_title_id": "ac8245d9-3297-41cf-ba79-35afba24c463",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-08T19:25:37.1801038+00:00",
"create_date": "2025-10-08T19:25:37.1801038+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-10-08T19:25:37.1801038+00:00"
},
"modified_dateutc": "2025-10-08T19:25:37.1801038+00:00",
"id2": 22
}