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": "78f022ca-1a63-4537-86c5-6a7fbaee16dd",
"_parent_id": "3cc56d8a-a697-45cf-8550-363d8a7dc4f9",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "87db2a68-06d2-487f-a779-3dab13eee14c",
"company_id": "0e70ad8c-df90-49af-8808-9adb8dc80790",
"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": "1299adb9-947c-4ee2-9636-e601851ee7bf",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6880bab8-8c41-4d45-a36f-ef39e1b5f0ee",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "96867186-c5ae-40da-983f-c1143a84fcd4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "38db9d3c-058e-4198-8eba-e01fd59e9a0b",
"company_code": "sample string 5",
"company": {
"id": "42fbceab-4888-42a4-b679-c00cf187ba14",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-21T11:20:01.7241275+00:00",
"sales_territory_id": "caf3295f-260d-4038-a3a1-aa0f50fd9ce9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "776923e3-4ad5-4e57-ab3b-0f80b5fec955",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "87b9d1c7-792d-41c4-86ee-80ab9e34e3e6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "28efcfd2-eb5e-407e-8dc9-da1e45a87f9d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0895008b-cdb1-4362-bca7-b45ba3c62180",
"db_currency_id": "9025a24f-c6bf-44cf-900b-fe4c4c87b630",
"db_language_id": "7fc7415e-3abf-47d6-b8ad-8ba4414fb3f6",
"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-06-21T11:20:01.7241275+00:00"
},
"modified_dateutc": "2025-06-21T11:20:01.7241275+00:00"
},
"marketing_segment_id": "ef71b8f8-470a-418e-b535-98c604bd52ee",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4d985daa-1321-4f1a-bc67-de3afca6fcb7",
"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": "30b4879c-ea6d-4f2c-8ab9-7295dab72a6f",
"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": "acd647e1-348d-4631-9217-aa525206376e",
"db_country_code": "sample string 28",
"feelist_id": "0e7db17f-842e-4d76-a078-7b80bb471704",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3100368c-7359-401b-814d-cb97c106a2c9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "19d3cae9-f1ec-4d9d-b6b8-f921a54f01ba",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-21T11:20:01.7241275+00:00",
"db_currency_id": "8e72cb25-43c8-46eb-a84a-210b7cdac9ed",
"db_currency_code": "sample string 10"
},
"company_type_id": "f1db4b90-ab39-42d2-ab30-53d6d8e06537",
"company_type_name": "sample string 32",
"company_type": {
"id": "ebc4ec1c-b1b6-4d30-bcf4-4ad7f1087700",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8456ec42-26aa-4198-a503-ebab97c1a6e6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d3b33745-5851-46d4-8d96-857119a6ae36",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f98e5b95-c53e-466a-bef0-73a73d938d45",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c4918b6e-87c2-4dd8-8220-d8f67fa70469",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a4294609-66e8-402c-b796-ea28cd4af4f2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-21T11:20:01.7241275+00:00"
},
"company_sector_id": "c5c06872-67e1-4b42-b38b-bb59ea1859e1",
"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": "fd2be262-7c8f-4671-8d8f-d4adac5c2f9c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e1687020-e42b-47bc-a0bf-5abfc71d0206",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "131ec15e-a172-4360-b0f1-750f74cc124e",
"account_manager_user_code": "sample string 56",
"company_status_id": "9717c871-2ef2-489d-be85-f33e9bbebb50",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-21T11:20:01.7241275+00:00",
"id2": 60
},
"db_language_id": "53bfa4d7-0bf0-405d-a12d-45fb95f9810b",
"db_language_code": "sample string 7",
"db_title_id": "afe3f6dd-4003-4f20-b4a0-8ee012154da9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-21T11:20:01.7241275+00:00",
"create_date": "2025-06-21T11:20:01.7241275+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-06-21T11:20:01.7241275+00:00"
},
"modified_dateutc": "2025-06-21T11:20:01.7241275+00:00",
"id2": 22
}