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": "e50a7319-7c75-402d-a37e-11288f0ecf9a",
"_parent_id": "f95ab65a-cf43-4ee9-906e-919a27590a95",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "be9e2e0c-0b29-4fba-90a9-e98f5ee0bb60",
"company_id": "32bf7651-12b3-4cee-ae39-a416f75907f9",
"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": "2b2eed22-aa7e-4428-8b73-40527b81c7e5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6a951d88-f823-43bc-9110-da9a0f910646",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "54e857ef-6964-47ee-a039-73932a883247",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "de3a97c8-98d2-41d6-bf1d-9115e624c2da",
"company_code": "sample string 5",
"company": {
"id": "e4d6f9ee-7967-49f5-862a-1db8e7b9b2e1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-07T04:58:25.6665758+00:00",
"sales_territory_id": "d3f8fcd6-e409-429f-8f7e-2517bf9041be",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "50d031d7-acb4-4670-b5fd-d1f8119ecb9b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "46782ead-52be-425e-b8d7-6584b6f19deb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5d1a5560-267e-4080-b3c0-9914e7f31473",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d95b89f-0446-4ed4-9419-a471a3d3cceb",
"db_currency_id": "7e925667-1223-473d-8feb-5f8b9ecee8d0",
"db_language_id": "af7f48b3-5e1f-4fa5-8ddd-b3b1c286e50c",
"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-05-07T04:58:25.6665758+00:00"
},
"modified_dateutc": "2026-05-07T04:58:25.6665758+00:00"
},
"marketing_segment_id": "b222a82f-6fae-4550-a422-48a7d7408492",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7291fe8b-501e-4da4-bb1a-eb9661688a06",
"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": "5d57cf76-244a-48b1-a904-fdad785f4a61",
"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": "47c13a22-f030-4920-b04a-cccc3b3f6060",
"db_country_code": "sample string 28",
"feelist_id": "cf03a314-46c8-4012-b00a-effb25468dd6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8a686be4-043d-4a40-a2f2-747f3768fd3b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "68fc2442-ba18-4c18-9161-e4596195f924",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-07T04:58:25.6665758+00:00",
"db_currency_id": "3f5b84e8-f33d-4957-a247-730baf8b5bbc",
"db_currency_code": "sample string 10"
},
"company_type_id": "7d418413-ad3a-4e90-a367-b38ed627321b",
"company_type_name": "sample string 32",
"company_type": {
"id": "c3e30cd5-d77d-4bdf-b834-7d3aa62652c9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c135a260-4439-44cd-b1f6-d7ab7bd9809c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "76fe6356-1b94-4fba-81b6-abeebedde6a1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6e29aac9-8b64-42f6-a131-6879074eaf91",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b8da6ebb-9ef1-4e46-b496-ee0a8d29a505",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7e386a91-84a4-4acd-a730-4df3fd0c6ead",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-07T04:58:25.6665758+00:00"
},
"company_sector_id": "5ff41f85-08e3-46a2-ae26-c19a8c6d7028",
"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": "78645770-d9d6-47c1-bddf-8a0015788339",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0102c140-b3ff-4bfe-810c-d33e8c7bb7f7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "537265cc-be28-4f6b-9f6b-66632f8e82a5",
"account_manager_user_code": "sample string 56",
"company_status_id": "f1f01bbb-4200-4c56-8b05-f894affb7b25",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-07T04:58:25.6665758+00:00",
"id2": 60
},
"db_language_id": "bd9cab9b-ba3a-4ab3-90e5-af5a50145a8b",
"db_language_code": "sample string 7",
"db_title_id": "68c64885-67e0-4d69-b11b-cb68d87e9a9d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-07T04:58:25.6665758+00:00",
"create_date": "2026-05-07T04:58:25.6665758+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-05-07T04:58:25.6665758+00:00"
},
"modified_dateutc": "2026-05-07T04:58:25.6665758+00:00",
"id2": 22
}