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": "e7fdfa80-cb47-498a-9906-bd72e4863844",
"_parent_id": "7b207488-e9c0-4827-bb54-1f8c15009f34",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "342ced35-5de9-43b6-8768-a1a31207a844",
"company_id": "06c876c8-c041-4a8e-9345-2f69e6549502",
"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": "cafa5208-4376-4809-8e4d-f537683178d8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0db5aa83-1d2a-42d6-9291-d61f8a5a5803",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ac3002c2-1520-4fd6-b341-6a936f468064",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "957110cb-0f8d-4e8f-aed7-8d57afd4cc1e",
"company_code": "sample string 5",
"company": {
"id": "d0bdac4b-2d0b-4888-a4fe-2776133ff532",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-04T01:10:49.889517+00:00",
"sales_territory_id": "151ac359-1256-4dfa-b1cc-8307dd27ed38",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5444953e-8df8-4670-a965-5f1fba8f1acc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f8e55906-1b25-4ed2-a536-aafe32ed15a9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fed95551-9596-4a7b-8a84-a03eae8723c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4350fad2-ad35-46e2-9f86-683e79be9e13",
"db_currency_id": "3ca13b13-2e76-4410-9ace-a0112c5dabf2",
"db_language_id": "e83a2fb0-16f7-4bdd-8a1a-1ba943868b65",
"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-11-04T01:10:49.889517+00:00"
},
"modified_dateutc": "2026-11-04T01:10:49.889517+00:00"
},
"marketing_segment_id": "acd202b8-2ff7-4a41-82a3-103ced4cd79c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e8f24721-088b-4c50-8e5d-985fcf787bb3",
"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": "9c8eee7b-fcf4-4d71-9d0d-350a54908e66",
"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": "f1984ac1-a28f-44e0-80dd-2c707574305a",
"db_country_code": "sample string 28",
"feelist_id": "b1113772-3ea3-4453-bf4f-36727b7efa62",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4680318a-d5d0-4b63-9bd1-a24f97cd9970",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e409c19b-8048-4fe6-a024-be662e538da9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-04T01:10:49.9070067+00:00",
"db_currency_id": "d2942a99-7b54-48b8-9f27-1f67306762d0",
"db_currency_code": "sample string 10"
},
"company_type_id": "0b4b9b8b-1246-4b8a-b604-9af8f657dd4e",
"company_type_name": "sample string 32",
"company_type": {
"id": "78bcf14f-17aa-4a82-92bd-b4a4dc44a2d8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2c09e47b-549e-41ba-af0a-ceee3d65e0a0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9885a42e-9176-41fa-a40f-6279260fe195",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "909f184f-f83b-44e3-a6c0-7fda316d1ce8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8356c330-8200-4b0c-a931-2782d500cc76",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8da679d9-f2ec-4c37-aa33-35efa69457d6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-04T01:10:49.9070067+00:00"
},
"company_sector_id": "dee5c3cc-6aa5-4fdc-b372-f6f68f480f36",
"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": "d0c34ab3-4bc0-4081-bbf7-9ffc0c33bbc5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b0a21277-0941-4996-b226-22ec28d892df",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b6460ef7-ec80-4858-82c2-461bd0f495cb",
"account_manager_user_code": "sample string 56",
"company_status_id": "6be63b5e-ec74-4e27-9941-79838bb2981e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-04T01:10:49.9070067+00:00",
"id2": 60
},
"db_language_id": "257bbac5-1011-4f90-ac74-a2da32fcc46c",
"db_language_code": "sample string 7",
"db_title_id": "346e7805-2277-4bda-9965-1246aabd381f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-04T01:10:49.9070067+00:00",
"create_date": "2026-11-04T01:10:49.9070067+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-11-04T01:10:49.9070067+00:00"
},
"modified_dateutc": "2026-11-04T01:10:49.9070067+00:00",
"id2": 22
}