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": "2f74bfd4-726c-4d42-af39-4a4012052100",
"_parent_id": "a8be2aa3-6c02-42fb-90c9-8eb52db4b301",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e6f052f2-2017-4d55-a705-233c91413dbc",
"company_id": "91e4242f-5146-4b8b-9c1f-3c5b63f31391",
"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": "4177b366-8705-48c5-a98b-80a1e7ec2b08",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3aae43c5-c115-4aec-8123-330a2dd93f94",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "749fd877-a142-4e2e-9183-ce66eece7424",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6cc3c3ce-f7d1-4852-ade4-b14eacaab070",
"company_code": "sample string 5",
"company": {
"id": "a7e47d3b-c1c7-4e99-90fe-c0dd92be5eb4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-08T04:02:51.8570053+00:00",
"sales_territory_id": "b78f0377-8101-404b-b9a5-54853e363a43",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bb2b46cc-c450-4614-8c8a-e47da5d53797",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f3daa3a8-f868-4b0c-a2c1-ab4461a4bd22",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "41379f7e-9300-43a0-befc-a36322e79c25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49674a10-2f59-4e74-b4b6-2db81b8e7ef2",
"db_currency_id": "0376d7ef-0947-4855-b26f-ac9f34743ff9",
"db_language_id": "fc5c81f3-4cde-4528-8fa8-a2f3a09ee541",
"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-07-08T04:02:51.8570053+00:00"
},
"modified_dateutc": "2026-07-08T04:02:51.8570053+00:00"
},
"marketing_segment_id": "0001d583-2580-46f3-94d3-4be8cb110f11",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a0fdf8e6-9980-40fd-854e-7e6617da9174",
"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": "eefaa456-352c-46a6-a29a-0b97ccca5221",
"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": "a6ea5120-2eda-41ca-852d-357bfdd599cd",
"db_country_code": "sample string 28",
"feelist_id": "55b7e1ca-cf0c-49c3-bdda-492f19867f8c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e2fc4fc6-9306-4580-b8fb-5dc1c192df95",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "906925e4-e851-4b47-9b02-0a7e0256090c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-08T04:02:51.8570053+00:00",
"db_currency_id": "e7443f68-284e-40e7-a2a0-6b5d5281de88",
"db_currency_code": "sample string 10"
},
"company_type_id": "b86be382-ef2e-4c48-8f2c-fe07ec06b5d5",
"company_type_name": "sample string 32",
"company_type": {
"id": "5ef5c340-c8c8-49bc-bebb-9003b9e6f447",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8982ec71-b74a-43a9-9166-354f8d978f6c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6bb3efad-b35d-4e2f-8a1f-a12e556a2c1e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4496e51e-7543-4ee9-8cc5-62a201f8f5b9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d7530517-e59c-4e9d-b96f-f7f4a3e9a86c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "24a063f8-c814-4cce-b6ca-3ece96838ac2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-08T04:02:51.8570053+00:00"
},
"company_sector_id": "2e412226-10c2-4a82-b62e-37eb951775c6",
"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": "e66e552a-19d3-47a3-9c3a-29ad546b48f5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b7bf4a30-ca76-4f2f-8f9d-ae95494f6abd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0f3af94d-453c-4e88-94e4-4c380a08e423",
"account_manager_user_code": "sample string 56",
"company_status_id": "bcfcdf13-45e7-4721-9ba9-16ae67525e96",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-08T04:02:51.8570053+00:00",
"id2": 60
},
"db_language_id": "1e866e6e-488b-4192-88e2-868e04751fd2",
"db_language_code": "sample string 7",
"db_title_id": "60a87599-2122-4e8c-9640-c81c2761ab0c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-08T04:02:51.8570053+00:00",
"create_date": "2026-07-08T04:02:51.8570053+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-07-08T04:02:51.8570053+00:00"
},
"modified_dateutc": "2026-07-08T04:02:51.8570053+00:00",
"id2": 22
}