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": "140f5330-f865-4748-85ee-3ef3fd702600",
"_parent_id": "773448ab-585b-4556-9c2d-96ea9027231a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c95fe242-cb38-4f5e-b1a8-97dc7ebdca36",
"company_id": "06c67826-f9fd-4e49-b269-691f2956f7a9",
"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": "a00f9da8-b761-4a6b-a1b9-f267650214ee",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "67d6f9b6-f5f8-47c8-b2b9-2823aedcba16",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f961a300-2e7c-4bfd-8dcd-a39051b835f6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3c1a191a-5930-4f52-81a5-93f01d45d503",
"company_code": "sample string 5",
"company": {
"id": "e4eb83d4-d98f-400e-904c-f8db8b50c2a8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-07T04:43:20.2801579+00:00",
"sales_territory_id": "0428433b-9b62-4ae9-a037-aa43b4895cdf",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "58d02a05-3764-465b-96de-aa88d482e1e6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2b5e2e06-4735-4ab7-a22c-6972f8fb1938",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "12d4febb-ec88-46ac-b4d6-e3d1ebe8b3bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b16899e9-5ce8-4105-8480-1b62eded6325",
"db_currency_id": "567366a7-a82d-4a55-a914-a317659c835b",
"db_language_id": "3fe47c7a-5d83-47ab-8b27-5e7031ba910e",
"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:43:20.2801579+00:00"
},
"modified_dateutc": "2026-05-07T04:43:20.2801579+00:00"
},
"marketing_segment_id": "f9815942-429c-4ba6-a652-52c3172955bc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fd920a97-06ee-497e-aa78-c73257fea1ea",
"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": "351199ae-aa2b-4655-8b4d-1d9ebe912df1",
"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": "c3b8758d-587c-4703-b8e4-c1123085b614",
"db_country_code": "sample string 28",
"feelist_id": "efa92373-b63c-44e9-b447-dc5199be378e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "39bc81ac-f373-4242-ac37-2dfea5a828a0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d2481d45-3ad5-4e8e-a708-fbb09e32c372",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-07T04:43:20.2801579+00:00",
"db_currency_id": "0826a535-d507-4517-b08d-c3a687a4dc51",
"db_currency_code": "sample string 10"
},
"company_type_id": "8361c65c-8193-44d9-bb4a-3a363146eb72",
"company_type_name": "sample string 32",
"company_type": {
"id": "93074096-8970-474b-a356-51318f8646fa",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "67b60ddc-a801-4739-9b22-7c5071d60cb9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e2304d84-1db6-4a33-b1db-f459f32ba42f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dde98f2a-e15b-4059-a4aa-532f762ca12a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6b488154-5404-4199-b677-f4a1570d4689",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3ba3ee96-e073-4313-be7f-85565ab13bc9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-07T04:43:20.2801579+00:00"
},
"company_sector_id": "6e99a6cc-2bf7-4f12-a4c6-d31044fd39d0",
"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": "34bb6948-5103-4f4d-b737-e28a3e3579a7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6487f704-67b1-4b16-978a-67b6ebb7580a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a9c37bc6-065b-4548-a6f9-2eac7987aaa5",
"account_manager_user_code": "sample string 56",
"company_status_id": "4793848f-7bc1-4f9d-b102-bf027aa7786d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-07T04:43:20.2801579+00:00",
"id2": 60
},
"db_language_id": "ba5a90b3-5d59-48b1-9104-ad8df4dcdf8b",
"db_language_code": "sample string 7",
"db_title_id": "c6c73eba-003b-49b9-89b2-161b4a4b2975",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-07T04:43:20.2801579+00:00",
"create_date": "2026-05-07T04:43:20.2801579+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:43:20.2801579+00:00"
},
"modified_dateutc": "2026-05-07T04:43:20.2801579+00:00",
"id2": 22
}