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": "16811274-7dcf-4e72-9815-80eca7dd6e33",
"_parent_id": "5ac935ed-d4a3-43f1-9407-4225949ca99c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "343a7331-686b-488e-b5d1-4fd27c4036f3",
"company_id": "1792c1d1-5b6b-4b8f-bf33-34ccad8da5d4",
"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": "d832f3eb-d07b-401a-a7c0-943d62d9bcc8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0817062f-04b4-442c-81aa-4c49ced4d475",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "7b04cb66-d70d-4de6-a3e5-9268b6db9014",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0f503d28-10b1-46e8-b2e4-9be49510b6ea",
"company_code": "sample string 5",
"company": {
"id": "c128fe52-06a5-40cf-b89d-f77acc83f357",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-07T19:31:01.4866831+00:00",
"sales_territory_id": "e3a7d5d4-2887-428c-a48d-fb9b9c8f367a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0ee2c6a8-ce8e-489c-b7c9-cc1448123fff",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "59efc0df-58a6-49e1-a970-b0f56d50480b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "81a7db0a-71be-45bc-8ec4-04aa88917519",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15159118-c5b9-4f80-b8bc-82b5a2ac1d82",
"db_currency_id": "a9fcac6a-51e9-452a-9a2f-1bf16310408a",
"db_language_id": "3bc4bbc3-796f-443f-a90c-0ca349227348",
"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-06-07T19:31:01.5023056+00:00"
},
"modified_dateutc": "2026-06-07T19:31:01.5023056+00:00"
},
"marketing_segment_id": "39d74c3f-60bf-4b9b-bd24-a932757273a9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "900ba897-e63b-43e5-8d3d-3cd1c12ff7e3",
"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": "e2964ab9-6317-4a8a-b65a-67e195f2afc1",
"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": "97dbf8a4-5fe7-4c28-9399-d0cd647dbf68",
"db_country_code": "sample string 28",
"feelist_id": "80280c73-cd40-4c1e-ab6d-a723d2fa35b0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4e01ce93-db37-420c-8543-85e1c6c07e80",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1ff82ecc-810c-4209-a603-d46aa5e31776",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-07T19:31:01.5023056+00:00",
"db_currency_id": "cfdd148b-9a17-4a40-af9c-ebbddfeb01b3",
"db_currency_code": "sample string 10"
},
"company_type_id": "b6671c1a-ebda-4807-912e-d6f3572ec1c4",
"company_type_name": "sample string 32",
"company_type": {
"id": "9739224c-ec83-4288-aaca-2a5ab4ee1800",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ef58692a-19f3-4290-9645-743eb6955242",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7dbfd2b5-86b7-44dc-9c34-4e083c9eeeb8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b37ab38f-08a8-4c76-b559-1bb73b024205",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "df705291-7fab-4073-a755-786c495b58d4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e6070c17-abf3-44cd-b219-bab99edf71ea",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-07T19:31:01.5023056+00:00"
},
"company_sector_id": "5e694622-3d64-4475-9083-c75cd6e6e24c",
"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": "d9709112-33bb-4178-b676-8cf35a50cf33",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "06b17942-48f5-404d-bdcc-58affb7a55ac",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "927ca681-f2ed-4193-90aa-4de53481c9ae",
"account_manager_user_code": "sample string 56",
"company_status_id": "c68a8449-3ea7-4f01-b3fa-8dcef8729477",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-07T19:31:01.5023056+00:00",
"id2": 60
},
"db_language_id": "2721dea0-6d2c-4312-a6eb-95b9dd75b3d2",
"db_language_code": "sample string 7",
"db_title_id": "f48f9b79-ce65-4765-9f81-229d4ef60da1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-07T19:31:01.5023056+00:00",
"create_date": "2026-06-07T19:31:01.5023056+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-06-07T19:31:01.5023056+00:00"
},
"modified_dateutc": "2026-06-07T19:31:01.5023056+00:00",
"id2": 22
}