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": "edfc38bb-64d3-4100-a985-7c5ad386aa14",
"_parent_id": "4a20260a-b76d-4b6c-acf2-1a4603675c00",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "578076e8-2003-45a8-8894-0646a10a7756",
"company_id": "c5bd839a-97df-4dda-b626-c703c3bb74c4",
"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": "e829cf28-8908-4758-b038-8bea5ab05061",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "aca4d428-f745-4a66-8f94-0cee356a3a5f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a7dfb91b-3350-4580-8d30-35e5c3b878a7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "595ce676-385d-41ea-8edb-5dbf80f48919",
"company_code": "sample string 5",
"company": {
"id": "335a80e2-02e5-4b15-bba0-7422f1e2c8c8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-04T20:25:41.4370444+00:00",
"sales_territory_id": "63b009ad-4717-4e60-9214-13274a0c2b40",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "98b671d7-fa04-48cd-8e26-aabd2d3b6c39",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2e7e0c65-9ccf-4eb5-a8b0-38561210b258",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2c672623-47cb-401a-afd2-8ccb84cb9348",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77a3ce98-f3a4-4ddd-93e4-8ab3467f5a35",
"db_currency_id": "01a397f4-3351-4cdc-a1c8-e538085bd821",
"db_language_id": "45415b0c-847d-4e1a-a32b-0f3ca4cf73de",
"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": "2025-09-04T20:25:41.4370444+00:00"
},
"modified_dateutc": "2025-09-04T20:25:41.4370444+00:00"
},
"marketing_segment_id": "16d000a1-731f-4d34-958b-23dcad7deb92",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ddcd39da-1417-43dc-b8ba-24375f2ac169",
"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": "632a7a7e-bb36-44e9-a197-f329c12b45bc",
"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": "67f4361a-0125-4731-a68f-564c0a48f482",
"db_country_code": "sample string 28",
"feelist_id": "4ab2f776-7adb-4d62-b110-80178a8c6684",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a4846dc7-54a4-473f-8db6-c7bc25ba9375",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fcc29061-b597-44ca-aea8-1bbcb0a29c4a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-04T20:25:41.4370444+00:00",
"db_currency_id": "9dbce6ac-c6b3-4a83-9e4d-90846b8fdc9f",
"db_currency_code": "sample string 10"
},
"company_type_id": "938026eb-fd87-4c2c-a478-3277c4b7e79b",
"company_type_name": "sample string 32",
"company_type": {
"id": "0ae5035d-e0e6-44c8-b7fa-a0d79da16d90",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "54d10a6a-ac28-4b34-a03a-cb5de7b0307e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5e4dcb2d-c8de-4195-a617-eacb54644f71",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "96a7d740-f27e-45b3-9be1-77494c08f742",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "aa3c68bd-8a2d-4675-b5b6-1d60fd4b1860",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2f5abe4a-7cde-4374-ac83-d6aa4cede7d0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-04T20:25:41.4370444+00:00"
},
"company_sector_id": "a181870f-d389-4c43-a527-c6a5795ecf42",
"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": "56c64c1f-6d36-4099-bbc2-00efaf557e86",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "54c9656f-04a2-413b-ba65-b43fce4ce978",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a102de83-7b7b-485e-9466-f4de0dcd4d30",
"account_manager_user_code": "sample string 56",
"company_status_id": "e9712e46-d981-4cb8-9274-1e814da4c5f2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-04T20:25:41.4370444+00:00",
"id2": 60
},
"db_language_id": "38cf6a2b-bcf3-4dd6-afd4-ea868d10bd62",
"db_language_code": "sample string 7",
"db_title_id": "809f0e21-aefa-4a3f-a267-6f8debd67375",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-04T20:25:41.4370444+00:00",
"create_date": "2025-09-04T20:25:41.4370444+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": "2025-09-04T20:25:41.4370444+00:00"
},
"modified_dateutc": "2025-09-04T20:25:41.4370444+00:00",
"id2": 22
}