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": "5f9f67d3-32e7-45a0-b4fe-e5568c9bf581",
"_parent_id": "040c4e38-ab3c-4f62-8042-f2d645a06633",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "95089fea-d371-4f66-9aa6-952120fb673b",
"company_id": "d083b584-1189-4cc6-804b-cdd479a64c36",
"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": "ce761846-3dfc-40ae-b34b-fef9772048cb",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ccedca21-cb6e-47bc-bead-99217c9bb3b6",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f45e8397-2aca-4b3f-9965-fecc59ea2484",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "028d5077-9c32-4a7c-a21a-6648d19450e6",
"company_code": "sample string 5",
"company": {
"id": "ac932b85-8df5-48c4-9b68-3c7bd4876df1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-14T23:31:02.9233505+00:00",
"sales_territory_id": "a62701f5-6e2e-4e75-83ee-0da35bba1b12",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "56b6ff96-97ad-44d6-82e4-8462361de37d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b41510ea-3213-45e4-a119-a731e4da76b2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a6989cc0-62e2-43da-a7d2-48557e43781f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08d034e4-2511-43c2-acef-626d0ad1f066",
"db_currency_id": "5a840172-95f4-44d4-baac-1beb3abd371a",
"db_language_id": "32648de2-bf7c-4529-89f2-bf715ba4765e",
"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-14T23:31:02.9233505+00:00"
},
"modified_dateutc": "2026-07-14T23:31:02.9233505+00:00"
},
"marketing_segment_id": "0dfabc43-2709-44cc-89bb-8407baa0fd6e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0365ac88-6b5b-4005-8b56-58a56858d129",
"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": "ce61c191-1fe5-4dc8-a4c4-55a086cdfde4",
"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": "395e98e6-8cf5-4a9d-bb1b-511d955f073c",
"db_country_code": "sample string 28",
"feelist_id": "acf07f36-405a-4182-b4fe-6dc6525d3cb5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a7749713-a64f-49d8-9b02-648832db3c49",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "30a0c37d-cbbd-4c7c-b545-292245554570",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-14T23:31:02.9233505+00:00",
"db_currency_id": "b0b89180-1364-4bd9-aea5-2e8d4a28a1ef",
"db_currency_code": "sample string 10"
},
"company_type_id": "7e6c1931-3c0b-4e34-89b9-4c4e6695f624",
"company_type_name": "sample string 32",
"company_type": {
"id": "074d0eba-6fa6-4310-a1e3-b54d801779c2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a10b9e8f-2361-422c-bbde-b24b869699f5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "549f60a5-1707-4cc8-bf6f-ef3d737d2d7e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2a3ae6c4-df39-4a3c-8b9c-22e4e8607824",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "625f91c4-4dfc-4282-b7ad-162e412ab61d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "45dbd6c4-44e4-497a-839a-7e0e05885342",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-14T23:31:02.9233505+00:00"
},
"company_sector_id": "1b18df8e-a215-4d87-aaec-6a3104de4104",
"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": "f07e97f4-92e5-43c9-a381-e1b8af742502",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a8070f34-52ec-471d-99fd-d88d16a55274",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "20f9c120-da68-4617-bae7-edc204af3db8",
"account_manager_user_code": "sample string 56",
"company_status_id": "de6d2516-752d-45ed-a6e5-c217bb119736",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-14T23:31:02.9389623+00:00",
"id2": 60
},
"db_language_id": "e0f0cc85-6efe-4552-aa8d-5ec55a6d4517",
"db_language_code": "sample string 7",
"db_title_id": "8ec2ea10-b8de-4a10-88e9-0cc1b1bef04e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-14T23:31:02.9389623+00:00",
"create_date": "2026-07-14T23:31:02.9389623+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-14T23:31:02.9389623+00:00"
},
"modified_dateutc": "2026-07-14T23:31:02.9389623+00:00",
"id2": 22
}