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": "3c9a34aa-5352-49fd-b77d-86be6d905750",
"_parent_id": "43a3e2b0-84d9-4c82-9b50-02c723713560",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "d179edc3-524e-4747-abf6-4afca5ff2978",
"company_id": "29eab65e-8439-413a-83f5-ae6a0ab29f4e",
"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": "927354ab-1b88-44e1-bfb7-ff9360c110ca",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0ebb6f10-1446-4c2a-9706-b4939ae97742",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "830aef3b-c569-4108-9138-850dc702c37b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4116c2f1-fcee-4a36-a764-1c0d3606351d",
"company_code": "sample string 5",
"company": {
"id": "8e5180b3-bc6f-487a-93c4-8714466df1e2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-05T08:46:18.3810698+00:00",
"sales_territory_id": "61b3f898-ed0f-4a08-a06a-6de943de89bc",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4af79a77-7264-4241-80e0-4d4c9a93eead",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c2c5127e-68cc-48a1-b9d1-fb22c5d7af9b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "154df106-a978-49d5-a5c6-fdbb472ad7df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fe05a89-4421-48ef-8eb5-73efa67b3e37",
"db_currency_id": "8f792830-87f6-4f20-929d-ece1fef9118d",
"db_language_id": "7c987865-3169-4703-a660-d4b1104ba95a",
"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-06-05T08:46:18.3810698+00:00"
},
"modified_dateutc": "2026-06-05T08:46:18.3810698+00:00"
},
"marketing_segment_id": "a61976e4-5eca-4250-976e-33042347831f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c532432e-399f-4686-afb1-41fcaed00ad6",
"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": "e8f5cda9-034f-4e22-8a3e-2d2ef064922f",
"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": "e18937d8-6c30-413d-a924-8cafffc62de7",
"db_country_code": "sample string 28",
"feelist_id": "2c0e699d-732e-4a19-9eb4-5379c49c0ec9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c556434c-0af9-4a21-a01b-4151d1bcc985",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d028e4e2-c945-4f21-9623-06cdd2a63171",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-05T08:46:18.3810698+00:00",
"db_currency_id": "c8b4a9df-79e9-45b6-ad3a-9f06d66a957a",
"db_currency_code": "sample string 10"
},
"company_type_id": "5650d942-d827-4197-b882-d3b3dc58c2ae",
"company_type_name": "sample string 32",
"company_type": {
"id": "4b3870b2-8a35-4805-ba03-57238812f83a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6b9d3e45-29b7-4809-a739-5b55c1843a1c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f065d653-ab74-4266-8b24-7dcb89da35bd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "70b6922c-b8a8-4e55-b2b9-c3c2b8dd6bef",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5ec0a305-f818-4431-82d8-01c97c79a9e3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "23d236a7-47e7-4d12-af31-22009340b384",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-05T08:46:18.3810698+00:00"
},
"company_sector_id": "f39ffe36-701f-4859-a9e6-71cbb963f985",
"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": "cebe366d-7cf9-472d-a6ad-53b8fb19dba4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6f83d5cb-951c-4dab-93e5-5d48889cb71b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "25c464cb-42e4-4675-8535-b9499f898c21",
"account_manager_user_code": "sample string 56",
"company_status_id": "0d6ba3cc-9422-408b-b6bb-3a970373fb0e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-05T08:46:18.3810698+00:00",
"id2": 60
},
"db_language_id": "00af90dd-2fba-464d-93e2-68a56a1d2e61",
"db_language_code": "sample string 7",
"db_title_id": "197ecfd4-1085-4b0f-90e6-26437cf74b7f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-05T08:46:18.3810698+00:00",
"create_date": "2026-06-05T08:46:18.3810698+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-06-05T08:46:18.3810698+00:00"
},
"modified_dateutc": "2026-06-05T08:46:18.3810698+00:00",
"id2": 22
}