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": "fd8fcbd2-45f3-4c3b-81b8-1966fd2306e7",
"_parent_id": "b79460b6-f351-4a8c-a8dc-5720084f8b34",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f24b4f21-7908-4dfe-a18b-1c1f134a75a3",
"company_id": "b4e64488-5ea0-46a8-b5ab-16a0079ca380",
"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": "50e33bf3-0508-4e83-a3f6-c582f84fa869",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a9224734-3f4d-46ca-b97a-a4ecb55a5dd1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6950a3c3-7570-4ed5-a3b4-c1065bebad63",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bc528c04-ec59-4c33-ae5c-78218b37d2c2",
"company_code": "sample string 5",
"company": {
"id": "249643b8-27e3-492e-8352-b609bac54deb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-03T02:22:24.0330438+00:00",
"sales_territory_id": "e38fc84c-73a8-4494-af1f-b8b1cb9f6177",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1aeef049-c78e-4731-917e-6029a1623cad",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "35c1a87f-2436-4856-8230-0b98d64137a2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0d4a54f5-0bb2-4ff4-9d45-79f0ec7d6243",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3dd594c-6210-4401-824d-352b205f9070",
"db_currency_id": "aea4ab19-5e1c-4077-ac26-1abd00b3d6b0",
"db_language_id": "065daf59-19c8-46b7-b7d7-1a5c62375a36",
"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": "2025-12-03T02:22:24.0330438+00:00"
},
"modified_dateutc": "2025-12-03T02:22:24.0330438+00:00"
},
"marketing_segment_id": "79f787a8-3d2f-4643-93ba-e52326d89bc7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9011f314-1899-4dcc-84b9-03a58f2aa1fc",
"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": "3886465f-22df-42c4-9e30-322ffe717b0d",
"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": "5524e15b-728f-4be6-b216-ad9bbf6f59bc",
"db_country_code": "sample string 28",
"feelist_id": "02793f5e-893f-4608-b926-0500b48c846c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "84741177-e83e-42c2-990f-394cec9172f8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "667a316a-dca4-41f6-9ab2-528e6242afb2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-03T02:22:24.0330438+00:00",
"db_currency_id": "83858b7f-0382-4089-b873-9f55b8750c81",
"db_currency_code": "sample string 10"
},
"company_type_id": "fecd7209-b756-4253-a68d-d525e41ed378",
"company_type_name": "sample string 32",
"company_type": {
"id": "c7d78598-b60a-4bc9-9c2b-8a22823d1d45",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "026f773c-b825-4773-9494-9be7d21dc4ce",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0455f5e8-dc5e-44db-b73b-b97e4616b39c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6e82b819-0fd6-4a4b-ad90-13abd2f50e8a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3c929f8a-fa4d-4aa7-89cc-971cbac9cddb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "31bbd822-5dba-4211-bd63-1fc3effa901b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-03T02:22:24.0330438+00:00"
},
"company_sector_id": "3f5a7a1b-5609-4520-ad2b-6eb2e51efcc8",
"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": "e9289bb2-adaa-4bc0-b1ee-79db07283dcb",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9bc47c9e-91e7-418e-8580-28051ba3cafd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a65bbc86-f08e-41d3-bc28-0a88c114b6f0",
"account_manager_user_code": "sample string 56",
"company_status_id": "84998a38-16db-4bca-99ef-7bfe4a0acf4e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-03T02:22:24.0330438+00:00",
"id2": 60
},
"db_language_id": "25c98787-e5ef-46f4-b803-b19db4227cc8",
"db_language_code": "sample string 7",
"db_title_id": "132688aa-e90b-4e16-b6ea-38d607319d29",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-03T02:22:24.0330438+00:00",
"create_date": "2025-12-03T02:22:24.0330438+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": "2025-12-03T02:22:24.0330438+00:00"
},
"modified_dateutc": "2025-12-03T02:22:24.0330438+00:00",
"id2": 22
}