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": "050cdf4a-5ed7-4a86-9c20-5a4abef9dd1a",
"_parent_id": "7330e8c6-3368-43fd-b5ee-0ac5b7e1ece0",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "27266d89-d70a-4ade-9d48-d245254c8663",
"company_id": "55c59608-c12e-46cf-b696-5ca62f1772c1",
"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": "a854bf5f-a69a-4f65-a50d-f7ce9f070093",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "eef93754-7331-41dd-8358-d30059fa7e32",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f73ee68d-7f66-4820-8730-90b5f328466c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f085778d-c30a-4569-8951-5c32f52a2a07",
"company_code": "sample string 5",
"company": {
"id": "0205f88d-6113-47a4-a80e-24562c3f93cf",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-29T10:36:18.0995382+00:00",
"sales_territory_id": "a63e395f-5062-4f72-97b2-c385308c64aa",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1aad01a8-e881-49a8-9f16-fb4be8fa4028",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fbdd7eb2-5b5d-4594-8730-37c3631ab3c5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "454dced2-c91c-410a-b19a-4b21f9c3719c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "75adb677-8f83-4b5f-a500-f79d1e3e18da",
"db_currency_id": "4987bf3c-85f3-4899-b93c-03653387f177",
"db_language_id": "bc016cce-d3ec-4be7-bb3c-273050383e7b",
"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-29T10:36:18.0995382+00:00"
},
"modified_dateutc": "2026-07-29T10:36:18.0995382+00:00"
},
"marketing_segment_id": "5e8533b5-1744-43af-92fa-68723c160eac",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fa19f0f8-7c10-464b-bd94-b02fc31985d7",
"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": "56d3b582-9466-4dbe-9e10-518243518a2e",
"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": "cc979e46-9a9c-469b-8ec0-070da106780b",
"db_country_code": "sample string 28",
"feelist_id": "d85bb2a9-de96-4c79-a6d1-a1026b937174",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "421fd165-95b6-47be-9f7f-e847de7f0bb7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "84d0b844-e9b6-40c2-9e49-4a86cb3723ce",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-29T10:36:18.0995382+00:00",
"db_currency_id": "1e6dd86d-950f-4462-92be-3adb81cad0cb",
"db_currency_code": "sample string 10"
},
"company_type_id": "16f5f8f6-308b-49fd-9d2a-eea8fb0a1f12",
"company_type_name": "sample string 32",
"company_type": {
"id": "bd10d822-c176-4db4-8b7f-1cebee02d72c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2db6151c-847a-45c0-9e72-861eb583b08c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2b65da1a-df05-44d6-b4a2-34f556d440ec",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d5047846-9254-40d3-8253-6bb9ceaa83ed",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8637800a-c536-4d86-be00-8c881a249dad",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "82c0753f-e29f-49d5-aafc-f6d49faf5e16",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-29T10:36:18.0995382+00:00"
},
"company_sector_id": "bfbe8eb4-0442-479c-874c-4bc80368805d",
"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": "a15d1e31-cf6c-4b8d-a697-82336edf6079",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "41357df9-fc7b-4f3c-994f-442d0af1a907",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6e3b2daa-953e-4379-bfc5-adc473557ab4",
"account_manager_user_code": "sample string 56",
"company_status_id": "fbbf1ef8-9149-4cfc-a6ee-ebe1c83b76c3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-29T10:36:18.0995382+00:00",
"id2": 60
},
"db_language_id": "8fbabda8-f291-4b52-8cef-2d738b123fc3",
"db_language_code": "sample string 7",
"db_title_id": "9f1fcba0-77ea-47d4-b344-f3022069eedb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-29T10:36:18.0995382+00:00",
"create_date": "2026-07-29T10:36:18.0995382+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-29T10:36:18.0995382+00:00"
},
"modified_dateutc": "2026-07-29T10:36:18.0995382+00:00",
"id2": 22
}