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": "d4fd1a51-c1a0-4f57-bb34-fe4c20368bf6",
"_parent_id": "44d8f64b-fee4-4d62-a7e9-17e6960c8ea9",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "46497b05-7d8b-48ee-8f15-67fb407f9060",
"company_id": "3f2ee82f-5f0f-4313-8bf6-5c897dae4ab5",
"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": "7da88211-32cc-448c-abd7-baafc73187f3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "cd55b475-1335-42c5-b78e-54a76d91de17",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "5b504d9c-4ab9-44ee-96ef-c7ee6a391ec4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "67b8ea5f-9f61-431b-bb9f-ef4396e1d055",
"company_code": "sample string 5",
"company": {
"id": "f171364c-e79f-45cb-ad15-7c4bc7235d16",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-29T00:38:43.7142078+00:00",
"sales_territory_id": "cdccf317-830e-4737-841d-4e3da385b9fe",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "51edebde-f8e4-4dea-98a7-72cd7d0614d8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "052469d1-0734-4c65-83dd-1d6de51fba30",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bf0bb550-aaa7-4856-8f40-7dac11ad3fd6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ddb9262-bf6c-4a69-8c88-a6871263b5cd",
"db_currency_id": "89db4161-17cb-4507-9e21-38d2bd7eb8c7",
"db_language_id": "887f0a54-3210-458b-92a1-d604f7a192b8",
"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-09-29T00:38:43.7142078+00:00"
},
"modified_dateutc": "2026-09-29T00:38:43.7142078+00:00"
},
"marketing_segment_id": "f83f14af-3c03-4877-884f-34e98156c2c1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5a63a4aa-59c0-4d76-b6df-7b1f7000d35a",
"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": "3c3582d2-79c9-4a44-b497-61067bc489f1",
"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": "f8d7bba0-6944-42ba-b984-602b771607a5",
"db_country_code": "sample string 28",
"feelist_id": "d3731e20-e109-44c8-8d5d-8e115655c705",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d83a5fcf-d140-4fb8-8704-98542430f85c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "86382856-61e4-4cfa-8797-6bde943d21ce",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-29T00:38:43.7142078+00:00",
"db_currency_id": "af7857d7-a779-4274-a36b-304a3a53a715",
"db_currency_code": "sample string 10"
},
"company_type_id": "54e50641-53d2-4c28-a560-cba5e949eae9",
"company_type_name": "sample string 32",
"company_type": {
"id": "252384a3-6030-4d30-a165-63bdb0dfeeaf",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e9f1ccec-0264-497d-856d-28f9cacec09d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "82600ac0-7706-4ed0-86c3-607d2347e812",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2a20f1c0-684d-45f8-a8c9-a65f09154bd4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a631d450-b2a8-4189-86e1-51804ef2d865",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "913751d6-9ab6-474c-852a-30b2b99a1ee2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-29T00:38:43.7142078+00:00"
},
"company_sector_id": "cff7411e-bbe7-4593-902f-758e3c4ab428",
"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": "ea0cb824-8a74-40c6-9242-c4b554f3a4dd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e7e680ad-20a4-4f38-900b-6806d0312bdf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ae87a349-f165-4bfa-8f24-f432371df251",
"account_manager_user_code": "sample string 56",
"company_status_id": "3ae9f5a5-fb6b-4377-8c3a-837c43b773b4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-29T00:38:43.7142078+00:00",
"id2": 60
},
"db_language_id": "85a94877-99ad-4c20-a274-b4d44dadfc74",
"db_language_code": "sample string 7",
"db_title_id": "bbec29d6-1c45-4ecc-9540-cf297e197c9f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-29T00:38:43.7142078+00:00",
"create_date": "2026-09-29T00:38:43.7142078+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-09-29T00:38:43.7142078+00:00"
},
"modified_dateutc": "2026-09-29T00:38:43.7142078+00:00",
"id2": 22
}