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": "5c6bbaa0-99fa-4027-b387-565bdce98266",
"_parent_id": "713fe021-12aa-4638-a3d3-05bb845bc388",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1850d40c-9ebf-40df-8a86-4b32de10272b",
"company_id": "c798736a-2fcf-4d25-b588-5cf2971dcb63",
"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": "f73f7424-98a4-4fb2-9a81-9c6b3e88c357",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e06516d4-f70e-4caf-8c81-0e12ad63012c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "90fcba12-ea0a-46f3-8be1-ad00a3eb55f4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "44eaa3ed-3d57-4856-b648-8d4c30c55f15",
"company_code": "sample string 5",
"company": {
"id": "15dcea76-d9f9-4b46-a849-d349cc566a3f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-10T17:03:16.8861153+00:00",
"sales_territory_id": "d339e9ef-de71-4e5d-80fc-cdc1cc51325c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6d27c7bc-53da-41f1-97a1-48e3d9d15a4c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8bf10cd4-975e-443e-8517-b25fca7b999b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f3cf11ad-8842-468c-b3a4-0d6c0ec834a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a5d05a7-6401-440f-8751-1e30e670afd2",
"db_currency_id": "23427c31-58e8-4bce-b019-288e635997db",
"db_language_id": "64c8334e-c4ed-4d72-a32f-08570df218d8",
"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-09-10T17:03:16.8861153+00:00"
},
"modified_dateutc": "2026-09-10T17:03:16.8861153+00:00"
},
"marketing_segment_id": "8b9064fe-2d31-48bb-b67e-b8811aea785a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "01e76de1-ac91-4854-8745-15864007d226",
"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": "8182b0fa-b84d-46ab-90ed-9aa23c2e1961",
"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": "d50e0b16-c36d-43b5-9b0b-65ad4f4aa909",
"db_country_code": "sample string 28",
"feelist_id": "528a77ec-0419-49f9-aba1-83039478838a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ffb9eba1-5ffa-4f21-808c-f61c3b0b2a3c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3b6e7151-3ffe-4dc0-a12d-da850ba94e5a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-10T17:03:16.8861153+00:00",
"db_currency_id": "4f67821e-2a33-4fd0-b057-014f34247303",
"db_currency_code": "sample string 10"
},
"company_type_id": "222696d0-6da3-4182-b7c8-c1a1cc01bb3f",
"company_type_name": "sample string 32",
"company_type": {
"id": "5c34110d-0867-4ec8-9dbc-bc4f3f095967",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "28a77a4a-99af-4ffd-8449-f4810e282f93",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b4c7df12-fd18-4850-a9b6-512ba2788d4a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2a07d2dd-9fe6-4759-994d-fdb902a81793",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "db6b782b-1afd-4949-bb0d-f10428f0f7b3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e8a760d8-e12b-4940-8ccc-cf23a9fec3f8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-10T17:03:16.8861153+00:00"
},
"company_sector_id": "070645ba-7105-4208-8c15-0609a58c87e8",
"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": "d4207cbd-e57b-4513-a14d-61ea75912802",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0369e974-3da3-43c4-96f6-3d1318f8c67c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "de0b00a4-cefe-4aa0-bf54-c2a67769df20",
"account_manager_user_code": "sample string 56",
"company_status_id": "1c26ef6e-f083-42e3-b2df-02be9037ce77",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-10T17:03:16.8861153+00:00",
"id2": 60
},
"db_language_id": "e49b1597-e66d-4509-89f7-27992c192c73",
"db_language_code": "sample string 7",
"db_title_id": "70739301-d149-44b6-beb1-8fb7bacd83bd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-10T17:03:16.8861153+00:00",
"create_date": "2026-09-10T17:03:16.8861153+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-09-10T17:03:16.8861153+00:00"
},
"modified_dateutc": "2026-09-10T17:03:16.8861153+00:00",
"id2": 22
}