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": "2b53af32-217d-4908-a06c-101287ff9bfd",
"_parent_id": "3646e92b-59e9-43e7-9b10-0b5d0359a744",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "fcb89c19-0e67-4503-9c40-d2cc07bfb231",
"company_id": "9454ad12-f960-4827-b6e3-968309470e12",
"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": "7527de15-fd1d-42c6-a733-834639a21dd7",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c9e46092-d198-45f7-a746-359ff1a835b4",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "75721377-4b98-4f81-ba5d-79ffa6d15754",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0e28465d-119c-4111-9374-28e004b74e82",
"company_code": "sample string 5",
"company": {
"id": "d3ffd47b-71aa-4412-849f-d48da6c5b77b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-25T02:22:24.1517278+00:00",
"sales_territory_id": "82a2fe94-089d-4a3a-ad9b-718e61827df1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f2c4fd4f-f787-4787-ae62-f00ec7a467fe",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b53b5e02-c242-45a2-b679-e1c733e06400",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "530088b0-deea-4ace-b48f-2e091273ab29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dec103fd-402e-4bed-9287-839294639f47",
"db_currency_id": "13a01087-244f-43d5-b2fa-e13232bdb6ad",
"db_language_id": "46d4eaa5-1ae2-46b8-963c-eda3aa0d6ea6",
"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-07-25T02:22:24.1517278+00:00"
},
"modified_dateutc": "2026-07-25T02:22:24.1517278+00:00"
},
"marketing_segment_id": "d4f995ab-7dab-40ea-ab92-877bb054ad3d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "26a9347b-1663-4759-a491-bf80bb885875",
"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": "9c41b04d-9793-4474-bd04-fb76f366da6b",
"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": "3154c410-0f2c-4267-af87-a29c68bb5dd4",
"db_country_code": "sample string 28",
"feelist_id": "48a6c80f-a284-49aa-aaec-00b3a90d6d79",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "804ec733-7a9b-4354-a946-25c6ea241e6b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ac8d046d-a9da-4d91-9883-1afce5e6ad19",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-25T02:22:24.1517278+00:00",
"db_currency_id": "b671f58c-1b26-4c13-b91f-5ef14770fa31",
"db_currency_code": "sample string 10"
},
"company_type_id": "8ecd7cad-1649-422f-b9aa-ab3fa00494d1",
"company_type_name": "sample string 32",
"company_type": {
"id": "5c640117-f3e0-4eb3-b9a5-3f7f5d001dd4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "863f4a31-ea4a-443f-834c-3d001dd75f97",
"sales_organization_code": "sample string 5"
},
"db_language_id": "af39da27-fd5f-43eb-a17a-5d7dfff085c4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "559db963-1625-4131-aefc-1387e966fe04",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3ae95758-23e6-43a4-8f60-50602c0bca53",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4bb98080-0b44-42f8-b44e-bb6df0f869d0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-25T02:22:24.1517278+00:00"
},
"company_sector_id": "c54bc5d6-ab17-4037-820c-5d7ac84c1ef9",
"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": "8bdf1a2c-a756-4e1b-968f-9accd4df1a31",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a0fc4983-51ff-43e4-a5e7-d771030eba2e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d4552bc3-d6dd-4e21-9e9d-9a8cc4b2d646",
"account_manager_user_code": "sample string 56",
"company_status_id": "edc442ad-8393-4cdf-a716-453b592e740f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-25T02:22:24.1517278+00:00",
"id2": 60
},
"db_language_id": "937c4991-3e1b-44df-a0d6-abfb032bd50f",
"db_language_code": "sample string 7",
"db_title_id": "e3e909ee-8c06-432d-bac8-7d607fe055fb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-25T02:22:24.1517278+00:00",
"create_date": "2026-07-25T02:22:24.1517278+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-07-25T02:22:24.1517278+00:00"
},
"modified_dateutc": "2026-07-25T02:22:24.1517278+00:00",
"id2": 22
}