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": "af988557-e161-4f09-a240-57820696151f",
"_parent_id": "67b1de00-5942-4b74-9a82-b9aeb4f8020f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "53ea16cb-c7d6-4efa-95ca-64c53a40a0f5",
"company_id": "a3ea9e54-cecf-4185-8f6a-c208be689f2f",
"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": "a243c57a-8c15-4b37-9ed1-1b643f3e6d9d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "dec08b4f-221b-4205-a83e-70179503e5aa",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "32def2e3-fa69-4b42-8d47-f72d6a7a523e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a49fd13a-e01f-4ea2-8c63-720d8f4630e9",
"company_code": "sample string 5",
"company": {
"id": "8e2edd4a-5d6a-45a0-9e0e-63773d53ac79",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-13T22:50:22.6015672+00:00",
"sales_territory_id": "624333a4-dec7-480d-a2d9-b4b5d0554403",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "daf00551-250e-4d96-9630-1585fbfbdd72",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "328a430b-901a-43db-a50a-54578a4293eb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c2247edb-63b4-4112-ac18-b2ca68dde428",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "258d820b-cf71-4403-8337-fe18944e5f14",
"db_currency_id": "2aafc9c9-9282-49cb-ade0-d36c381ae331",
"db_language_id": "4566e267-9a75-4bd7-97a1-d0ed6134dd5c",
"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-10-13T22:50:22.6212842+00:00"
},
"modified_dateutc": "2026-10-13T22:50:22.6212842+00:00"
},
"marketing_segment_id": "ff31305c-8d71-4da2-ad97-5c495cee4d83",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "22221ba4-4dbd-4a47-980a-d1d985d596af",
"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": "a936e4c5-bc4d-46f5-a4bb-05142c8db18c",
"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": "b2a44e80-6752-45e3-b60e-2b5b7aeb1043",
"db_country_code": "sample string 28",
"feelist_id": "adb4c2ce-9b94-4051-b4cc-995294accdff",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "98e9315e-71ec-4dd2-bd7b-f8a978bbe0e0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6234c43c-480e-4e8e-b069-6f8aab7d20e9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-13T22:50:22.6212842+00:00",
"db_currency_id": "a11f5e70-22a1-497e-b6da-3e0ce3f56fc5",
"db_currency_code": "sample string 10"
},
"company_type_id": "c21bbc97-dc9a-4a35-97b0-5b278c5d84d4",
"company_type_name": "sample string 32",
"company_type": {
"id": "23834a84-92da-444f-b8ad-af83d4c96f5a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cbc8fd03-2096-44cb-8733-f960c26d3813",
"sales_organization_code": "sample string 5"
},
"db_language_id": "eb66ca62-5c5b-4bf8-9648-2742fa42ff17",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c5b460e0-6ab5-4f81-b9a4-8aedbd7ef0b1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "88125ec9-ca9d-43fb-a7de-4a504fe618b5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2db64a0f-e229-4688-92cc-a01eea8fb11a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-13T22:50:22.6212842+00:00"
},
"company_sector_id": "6b53b480-976c-4562-811a-10c7955576da",
"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": "057558d5-dfc0-4689-99fa-7c9ab70c67ae",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d9f2b3b7-6348-43a3-9d9d-3130f494246d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d68be7f0-1fdb-4f19-85b2-10311d3234bb",
"account_manager_user_code": "sample string 56",
"company_status_id": "aab558ed-708e-4bb7-b000-951ab3b9d1ac",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-13T22:50:22.6212842+00:00",
"id2": 60
},
"db_language_id": "c4a745fd-2e07-4c84-b06d-71e83532c207",
"db_language_code": "sample string 7",
"db_title_id": "fc824550-8b8d-4538-bfb6-fc3df3e23986",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-13T22:50:22.6212842+00:00",
"create_date": "2026-10-13T22:50:22.6212842+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-10-13T22:50:22.6326668+00:00"
},
"modified_dateutc": "2026-10-13T22:50:22.6326668+00:00",
"id2": 22
}