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": "53fd6b69-b92a-4bba-8e38-3654e7cc6c94",
"_parent_id": "cbe6afa9-b8f8-4ccd-accf-0c84dc9d0083",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e3c2d7e4-af4c-44f3-977a-f9699b9a15e4",
"company_id": "9da39cf4-3eb4-424d-94a6-fb29b07d5156",
"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": "8262724f-bbcd-4d78-b316-0679a3ca092f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a280fedf-b014-441a-bc81-b461e1b6ed09",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "928bc852-9f6a-4919-9ec9-1dd754d8edfa",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dba238b1-f770-45bf-9216-fa4b70513966",
"company_code": "sample string 5",
"company": {
"id": "7344acb1-aa00-4772-b04a-99196459cf44",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-02T19:52:04.4401173+00:00",
"sales_territory_id": "d3ec2dd5-1c3f-42aa-ba2c-9ccbd037c6af",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "30fcea0a-a39c-4dd4-8b70-31a4a6b43a5c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ea3cd3eb-e1bc-4525-99c9-2e1b85a0b120",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c35efabc-22cb-4525-89f0-6e20501cd85b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d27302bf-f759-4e64-8d64-2f0b6a9c1bc0",
"db_currency_id": "0f27ab73-efb9-48c7-b31a-54a137790ea9",
"db_language_id": "8d354564-d947-46ff-a3fd-73369ef97251",
"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-10-02T19:52:04.4401173+00:00"
},
"modified_dateutc": "2025-10-02T19:52:04.4401173+00:00"
},
"marketing_segment_id": "076f278a-a8e1-477b-9ff7-6ee1649ff3cc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a4163b4d-e598-43a6-aea8-ddd472694768",
"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": "cce6d67a-20fd-4147-aac1-adf662fa1205",
"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": "0fda3de3-958b-46d3-a759-09f514dcc384",
"db_country_code": "sample string 28",
"feelist_id": "59888c9b-f3f3-44c0-9578-73082c49e60d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b68cee62-a325-4e9b-851e-37bd0aae21dd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "90fbac92-8d29-459e-b7bc-b85d67a518bc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-02T19:52:04.4401173+00:00",
"db_currency_id": "a502feaa-c77e-4646-ba40-c036e7a29c0e",
"db_currency_code": "sample string 10"
},
"company_type_id": "42e8c0e0-7188-44b0-8ae6-1c038c057dfd",
"company_type_name": "sample string 32",
"company_type": {
"id": "9835f158-70bd-4fe7-9493-2de0c0e325c1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6cfbc227-b7ac-46ba-9377-2025ac25594e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c80fcf2a-4aee-4621-9cf9-f1ffc6995977",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7377e250-4c0a-4f0b-8633-98b69e5caea0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b266c9b7-64d5-4072-ba84-32e86d2a1467",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0b1ce723-7386-4d21-b2c4-9f767113fcbc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-02T19:52:04.4401173+00:00"
},
"company_sector_id": "70fc84b9-258c-47b6-a451-e579e08b1e5d",
"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": "8de2d73a-9c3b-43db-a136-39e335a45822",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "81e71600-5934-429b-9c84-dfb8e8608935",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0dc8cd26-aad0-4586-a4fc-23fe2119d7c7",
"account_manager_user_code": "sample string 56",
"company_status_id": "b643e6db-2f62-499e-b6fb-92d871321c0f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-02T19:52:04.4401173+00:00",
"id2": 60
},
"db_language_id": "598c9286-b70f-4602-a603-528ef563dc80",
"db_language_code": "sample string 7",
"db_title_id": "b578f21c-844d-4335-a106-0bad3f3f403b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-02T19:52:04.4401173+00:00",
"create_date": "2025-10-02T19:52:04.4401173+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-10-02T19:52:04.4401173+00:00"
},
"modified_dateutc": "2025-10-02T19:52:04.4401173+00:00",
"id2": 22
}