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
{
"id": "db7c58cc-58d9-4bc0-a44a-e6a3c69fd3ef",
"_parent_id": "955196f2-dcd5-4646-882f-e8323ad83a85",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "4765abbb-620c-4ca9-9ee6-0bb97e121d89",
"company_id": "a9fab8b6-e9e2-4b3d-8f28-8890b2e479db",
"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": "80b7e8a0-368a-4c17-9427-5179df63be55",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "bb31365b-bb5c-4495-b413-ec3260a22ef5",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "04e25247-4cec-467a-bd2e-9d253dc8e728",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5523dc51-b6e1-4e19-838b-18d9e825a3f2",
"company_code": "sample string 5",
"company": {
"id": "3686991c-5b47-4691-9920-65c995dff385",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-21T18:35:10.0857511+00:00",
"sales_territory_id": "a1937ed2-b732-49ec-9eca-1c2eb8bf087f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b486f2a1-b4ce-4b33-bbc0-d3dd45e70a1b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c5ff4eaf-605f-4b18-82aa-84cd4e7681d4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "374ed3c9-72e9-450a-89e4-74bea1f40fb0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a29ab9cd-03f8-401b-a4d9-6b88d8dfdb2a",
"db_currency_id": "46c1e8ee-80a8-4182-9f83-c999d4100097",
"db_language_id": "d0d91b80-ebe2-4464-8e4d-da2f2815e8a6",
"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-21T18:35:10.0857511+00:00"
},
"modified_dateutc": "2026-11-21T18:35:10.0857511+00:00"
},
"marketing_segment_id": "89a715ce-06cd-44b7-9950-b8fc4b1a37a6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8707547a-fe3b-4bcb-8448-3f83c2776d3e",
"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": "31f9d818-d351-433c-9385-5e19613c1612",
"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": "83986079-0576-4652-823c-667139a5de1f",
"db_country_code": "sample string 28",
"feelist_id": "7fe44715-caeb-42c1-8f60-40f7db25fd24",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "873ea2f4-215d-4bd3-bd27-ef30b27d2b6c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6ee477ae-3807-44f6-832e-929cf7e073db",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-21T18:35:10.0959327+00:00",
"db_currency_id": "847eca10-4f9e-4067-af0c-12471baf4628",
"db_currency_code": "sample string 10"
},
"company_type_id": "1806518e-b9c0-46b5-9ef0-f0d891888f78",
"company_type_name": "sample string 32",
"company_type": {
"id": "f6e9dfbb-ef4d-4470-bb90-9a7ecddd65a4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "31d2d58b-d2af-4098-9c8f-35e04855f0e5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c32cc25a-d783-44f2-93c6-ac39244cc4a0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5b182988-5f55-406f-a594-b87b450f69a0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b108afd2-e0d1-4147-b337-c5e2b9986b00",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1d689e04-a6bf-4683-b870-f658233a007d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-21T18:35:10.0959327+00:00"
},
"company_sector_id": "d345209d-8989-42d0-9d94-87b42aacbbe1",
"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": "4933d3e5-763c-4a57-bb99-7bb4dac75bfd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ea21661b-0fe5-41fd-a17c-a4f75c1bd805",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "badbc177-0f42-413b-9cf4-a64a4554c3f6",
"account_manager_user_code": "sample string 56",
"company_status_id": "8ff0c574-b069-403c-9438-887039707978",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-21T18:35:10.0959327+00:00",
"id2": 60
},
"db_language_id": "10fd08c8-0753-4cd8-854a-72e028e62665",
"db_language_code": "sample string 7",
"db_title_id": "d37c0949-97a1-4279-b618-0eb3411d3c3a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-21T18:35:10.0959327+00:00",
"create_date": "2026-11-21T18:35:10.0959327+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-21T18:35:10.0959327+00:00"
},
"modified_dateutc": "2026-11-21T18:35:10.0959327+00:00",
"id2": 22
}