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": "a3e500e5-43f0-4eae-b7f3-d09b07f0a8fb",
"_parent_id": "5ad8fedc-3418-4f97-892d-2270567c62cf",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a8efb66a-37c0-413d-bad5-cfd31db14404",
"company_id": "dc5db574-4560-415c-97dd-3a8f73f4ffb9",
"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": "3179576d-8f08-42f0-b75c-0751a88de003",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "bd587800-ea54-4909-8a95-a4d60b7a3e31",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "56b8b778-b65d-4525-a4e0-3fefb977597a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "386d85c7-f249-4932-8334-2f7f7f8896d0",
"company_code": "sample string 5",
"company": {
"id": "96ea6b8a-2992-49ef-bad8-534f62e36da9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-31T19:30:01.9713265+00:00",
"sales_territory_id": "4a5c7b43-9bbe-4c8c-b02b-533e58a2327c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "40d91ee0-0efa-4b2d-841b-5a09506d9ada",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2fc45f44-3df0-4b1e-8c49-86f7791945c8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f9d56b19-9c24-4c01-b488-9ece372313e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "145e1076-1770-4334-af62-1e9a7aa53c8d",
"db_currency_id": "5d6c3cf4-36c7-4db3-8670-cd3067af9ba0",
"db_language_id": "ae811818-57df-4e1b-b86b-9506d25cef96",
"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-31T19:30:01.9713265+00:00"
},
"modified_dateutc": "2026-07-31T19:30:01.9713265+00:00"
},
"marketing_segment_id": "ad422734-6ea3-421e-8209-fca6fb951c89",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "049b560a-cfd3-446f-9871-8a6d91d0c66f",
"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": "eb2d335b-def2-4e07-b95f-f8d977051391",
"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": "1db7d22b-9f29-4dec-afad-675fae19502d",
"db_country_code": "sample string 28",
"feelist_id": "828e904a-0348-4db6-baeb-35d94181451c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7228426a-f33f-40e3-8a45-3fb37e4369d0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fac05010-d24c-4837-8827-150ba2ad4cc4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-31T19:30:01.9713265+00:00",
"db_currency_id": "12e77aa7-8ab2-4dd2-8721-155045b260eb",
"db_currency_code": "sample string 10"
},
"company_type_id": "53d3b48c-dc82-4038-87ea-df0d9250df6e",
"company_type_name": "sample string 32",
"company_type": {
"id": "6bf41334-5f96-4cdc-9681-498c37eb8d89",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "51b3de81-2e17-4a1d-9480-83bbae17a144",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3e0db86b-7245-439e-817f-5853ae492f33",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d967aa13-1e45-44a3-b993-a18cbb1422c6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "552efc54-9d06-4918-b1cd-e1fde08bd75a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "dc259e55-6625-4946-8525-dfa01d21f33b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-31T19:30:01.9713265+00:00"
},
"company_sector_id": "daacc3fb-fc23-4563-88f9-5c6e52c08dc0",
"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": "13dc440c-908f-40d2-a645-175d6d7de5ff",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2654712e-f788-4bc1-9890-3d08ba56f622",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ce6e9078-3b17-4468-9bc1-5bc75f26abc1",
"account_manager_user_code": "sample string 56",
"company_status_id": "0f2ab94f-9c6e-41ba-8da8-f69f5cac376a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-31T19:30:01.9713265+00:00",
"id2": 60
},
"db_language_id": "eb8526f0-73ed-4bef-ac2e-6161c82018b0",
"db_language_code": "sample string 7",
"db_title_id": "4e15c406-3b13-416f-a154-eabfad5057a8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-31T19:30:01.9713265+00:00",
"create_date": "2026-07-31T19:30:01.9713265+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-31T19:30:01.9713265+00:00"
},
"modified_dateutc": "2026-07-31T19:30:01.9713265+00:00",
"id2": 22
}