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": "14823d02-2a67-408b-b954-ff5e1332a8f2",
"_parent_id": "823e9973-1526-48f9-ad59-4fa14dc51bdc",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9ab98673-a9d4-4a40-892c-903395d7728b",
"company_id": "7f242811-fefc-403b-8f50-18e47d5c249e",
"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": "e60349f2-9849-40aa-b99b-d4a8a5956afb",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c2f0cce8-e876-4dd2-a8d6-29fe52c022d6",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a9c7abe6-83de-4a36-8577-2ed0776176f3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fe26ead4-af27-448b-badb-fefd736b8c03",
"company_code": "sample string 5",
"company": {
"id": "924f0186-4b3b-46fa-89dc-d9cbcf421b51",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-20T10:47:01.5593482+00:00",
"sales_territory_id": "84cae6a2-e738-428c-9bb0-335e67c55207",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c3a8d81b-13c6-4cb5-ba70-cb909296d3f1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "24eea3d1-512a-40f7-ba64-68aaa49499ff",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "12aca3ff-3a08-4e1e-aa20-0103b82deab6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "732f9546-de19-4793-acb5-4949c816c213",
"db_currency_id": "042a2b91-8776-4f56-8d4d-d6e12e0da277",
"db_language_id": "af9fb7c0-79de-4771-ac34-8f7d5d91a88f",
"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-08-20T10:47:01.5593482+00:00"
},
"modified_dateutc": "2026-08-20T10:47:01.5593482+00:00"
},
"marketing_segment_id": "fb94ac44-619b-406f-a1eb-f5e6b94457ad",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "29116b60-1e7f-4126-a723-4e642da0dfef",
"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": "c7dadef0-4d21-4a9a-a3dd-6ece7ec1d5d5",
"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": "fa7516c9-91f8-4985-9877-f871e4f96962",
"db_country_code": "sample string 28",
"feelist_id": "6acc6e67-d38e-41cc-9946-f3ff6039bdf8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "75aec7b0-2721-4bab-8d31-532373aab200",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b1b1a975-e192-45fa-8d74-82a1f51bba21",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-20T10:47:01.5593482+00:00",
"db_currency_id": "1b51cc06-01cd-4305-af4d-a1bb15dffde8",
"db_currency_code": "sample string 10"
},
"company_type_id": "3b2b9dab-230d-4e82-95d6-41b558849e2b",
"company_type_name": "sample string 32",
"company_type": {
"id": "d370f769-bda9-4f6d-8500-b946b065d133",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3eb7eb50-bbae-41b9-9f7b-f5a8a593f2c6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1e5d93df-b55f-4022-8974-7d6275bc77f8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dafc997e-f4a2-47dd-b934-3b2474135d69",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3876978a-6025-415d-8bc8-ce353213c50b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c284a211-3cf3-4e7a-9748-b029dab8079f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-20T10:47:01.5593482+00:00"
},
"company_sector_id": "f4ecffaf-b959-43ea-b01c-a5350bceb461",
"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": "1d448c6c-c662-4ae7-9442-cd5aac180579",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "97abba70-5458-4d3a-835f-0e7fba40e8dc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1e923b0b-8471-4a88-8572-464f7d8c0628",
"account_manager_user_code": "sample string 56",
"company_status_id": "5dda9fab-7795-49e5-b867-b0776908a4ef",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-20T10:47:01.5593482+00:00",
"id2": 60
},
"db_language_id": "2e482a6b-9485-4526-b143-f3f39b56a3e4",
"db_language_code": "sample string 7",
"db_title_id": "f5c82b69-3fab-44c2-a9c5-3dd09db1467f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-20T10:47:01.5593482+00:00",
"create_date": "2026-08-20T10:47:01.5593482+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-08-20T10:47:01.5593482+00:00"
},
"modified_dateutc": "2026-08-20T10:47:01.5593482+00:00",
"id2": 22
}