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": "4fe8045c-737d-47f2-8879-af2ad9780c66",
"_parent_id": "9b46ef10-5fb0-4997-ac57-31222d929645",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9ef48fc1-55dd-487b-b1b4-d23c659286a3",
"company_id": "7b2f744d-249f-4fcb-90ca-5cbbf93951a1",
"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": "410cc444-3902-4d3e-9d97-b912a658a36d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "01076766-8a99-470c-a4d1-0d66cbc39492",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "faef823e-d99f-4ab5-a174-a332c85755c3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f5ecd826-4e28-401d-814f-491e4ef22732",
"company_code": "sample string 5",
"company": {
"id": "e7c84e2a-0fa9-443c-8e6b-705687ed2d4c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-08T07:43:46.0950281+00:00",
"sales_territory_id": "b9366749-5405-4833-a6a9-5cc6940425d9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "141d9d3e-0b02-480f-887b-1be443359d8a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e0dc5d17-109a-45cc-9b21-0d565b5bc1c9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f3f97df1-626b-4eab-8cdf-44ac85c67448",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e99fdeab-f74a-4a6e-87da-2bc81328dcea",
"db_currency_id": "80adb4cc-de4f-4879-9e6e-69139dafe9fa",
"db_language_id": "f5f2608b-1029-4e7e-8232-f6df6a9d3b35",
"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-08-08T07:43:46.0950281+00:00"
},
"modified_dateutc": "2026-08-08T07:43:46.0950281+00:00"
},
"marketing_segment_id": "6d0b10bc-aeb1-4006-b13a-567868282ad3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bf42d4f4-3db1-4156-b30a-fcfb1600d76b",
"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": "43e3beed-23d1-498e-a313-4994dbae597d",
"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": "f66502fe-5bbf-4342-b4de-de3a71c3e3e2",
"db_country_code": "sample string 28",
"feelist_id": "5a3efc60-d4ea-4666-9c9e-980ddc2ef759",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cf439e08-96db-4e5a-97dc-60db22d64d39",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c8eccfe7-dd1b-4a4b-ba9e-6064ab0f1f0e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-08T07:43:46.0950281+00:00",
"db_currency_id": "d35ed2e6-b6cf-4ba7-bf0e-aff7dbfde9fc",
"db_currency_code": "sample string 10"
},
"company_type_id": "b1807fec-80ea-48db-8861-4f49b491fb06",
"company_type_name": "sample string 32",
"company_type": {
"id": "be5db451-0977-410a-b433-642777f050c2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "692db29f-4574-4226-9e1c-9aaed31acf18",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ad0e48cb-4653-4436-b688-b9e437c2650b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "896c0da0-9e05-4a33-9239-9b7708c983ef",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "591120e5-6014-46f9-a1f0-360ad8389966",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9c024496-1c0b-4fc9-8f0e-83e392baf3be",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-08T07:43:46.0950281+00:00"
},
"company_sector_id": "dce07549-28fa-4d9d-8326-ec036e749e9b",
"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": "a8bf5d00-29a8-4b21-b58a-ba7dc54e20d9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6e47a1bc-fc02-40f6-bf3b-0f35954ca3bb",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1399e49a-f772-4ebf-90a6-61440bea67d3",
"account_manager_user_code": "sample string 56",
"company_status_id": "3b9fe450-2063-43da-a031-343eb6fdc2e6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-08T07:43:46.0950281+00:00",
"id2": 60
},
"db_language_id": "4d148b23-edc6-4af4-97b2-3ced51b8bb91",
"db_language_code": "sample string 7",
"db_title_id": "5950127b-7f1d-41f1-af9e-cdecd661bc6c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-08T07:43:46.0950281+00:00",
"create_date": "2026-08-08T07:43:46.0950281+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-08-08T07:43:46.0950281+00:00"
},
"modified_dateutc": "2026-08-08T07:43:46.0950281+00:00",
"id2": 22
}