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": "d2b67b71-65b8-498a-8ff8-75cf7a71da63",
"_parent_id": "f4919eca-cf08-4f26-b62e-a392faa429ff",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "fb781532-0c93-49b6-9d8d-71c37a7eaac7",
"company_id": "59df7ad2-ab21-470e-8f62-d726bb5ad268",
"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": "284bbe86-6685-4fca-91aa-0052d9b4e54b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f1fa05bf-789a-4c39-a8b2-006ea060dcb4",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "bca233ce-f4ad-4b9d-89b9-ac2563599315",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d826fc32-4e27-448a-812d-3257b38736b9",
"company_code": "sample string 5",
"company": {
"id": "2f0f0e98-901a-4a95-9afc-0cb2072a8e4c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-02T17:57:19.2998707+00:00",
"sales_territory_id": "2ff1d4ea-c905-4883-9c62-dfb8d15ea4f7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6c7053f0-95fb-414e-91b8-c855b554f384",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c94a524d-7351-49e5-9c06-87240abab7d5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "80573ad8-5946-44f6-968e-ebdc61469dd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a94e2b1-9dc2-4fc5-ba0d-242923ab2cd0",
"db_currency_id": "a577d8aa-7a7c-4ffc-a68d-f8ccc9f1927d",
"db_language_id": "2118e713-60a7-495b-8e59-2965178fdfa0",
"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-03-02T17:57:19.2998707+00:00"
},
"modified_dateutc": "2026-03-02T17:57:19.2998707+00:00"
},
"marketing_segment_id": "02f69a77-d325-4a3c-b702-2032c733d50d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b4e812f5-d623-4116-bc86-a72a1034f351",
"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": "25ccc33c-a4b6-41af-9e84-8c850645d4b5",
"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": "1c1aab27-6a15-4804-987d-9297143731a8",
"db_country_code": "sample string 28",
"feelist_id": "c0c04a83-64b5-42a4-88a5-e6d602aa7702",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "aee522e1-35b3-4cb4-828b-ccfebb979d49",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "828842e6-cc32-47e9-8abc-ae05e55d6125",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-02T17:57:19.3154996+00:00",
"db_currency_id": "d1e4fa4f-5a84-4f86-85ea-8ba2cb67760b",
"db_currency_code": "sample string 10"
},
"company_type_id": "ac0c3c3b-a587-47b8-9ccc-8c6d20c1af74",
"company_type_name": "sample string 32",
"company_type": {
"id": "6d0ffc0e-2651-4388-b84a-d6c3bb8d5e65",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "260514de-43ce-4e90-a6b8-78fa6e332805",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5d0985cb-df5a-4071-8a6b-d556c05891fd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bf509469-a87b-4192-b26d-9a7f5d894add",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9864fc6f-98b8-425a-82b1-5b48955782cb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "13f8274b-413d-4446-8c73-bafcf96404f9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-02T17:57:19.3154996+00:00"
},
"company_sector_id": "2596bd18-da3a-46b0-9aea-a24281c3cab0",
"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": "39a8ec5e-21b0-4cd6-99af-7f8dc1df0185",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0ca6d05e-c868-41d7-b698-cfc6a90bf408",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6bb8b804-d18b-48ed-af6c-8ff06548db07",
"account_manager_user_code": "sample string 56",
"company_status_id": "47ffad1b-9c78-4ff2-973a-996f794a7ec6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-02T17:57:19.3154996+00:00",
"id2": 60
},
"db_language_id": "973c808f-7d89-44a2-8ff8-87e9d4c9bb46",
"db_language_code": "sample string 7",
"db_title_id": "713d1fad-576e-4dd3-97c6-460f68c53844",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-02T17:57:19.3154996+00:00",
"create_date": "2026-03-02T17:57:19.3154996+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-03-02T17:57:19.3154996+00:00"
},
"modified_dateutc": "2026-03-02T17:57:19.3154996+00:00",
"id2": 22
}