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": "b5b8a097-cafd-49b4-9a53-6a9bc46bc0b9",
"_parent_id": "0ff2f961-b7e6-4154-a0d3-51d90e8d7cec",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "89830b04-6869-4f73-a776-af9be15550f4",
"company_id": "022fe905-5dc7-4ee5-b801-487f59d76a78",
"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": "2cc75751-a4b6-48d8-a5c8-0b2b80e016ad",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "37e7e7a9-2f72-466b-87d7-756b97eda468",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "59b207e7-4f5c-4fe8-80d1-a64083a6545e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "20a6a089-1557-47b8-ac40-eab4111b321c",
"company_code": "sample string 5",
"company": {
"id": "41770bad-20a8-49b9-a3ea-dfe5e16cc33d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-26T19:44:15.3357753+00:00",
"sales_territory_id": "77b86ccd-d8f4-4cc3-94de-99df8d2b43c0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6228f6d7-c2bb-45c8-bfca-c76284822ccc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5614fb27-95f7-4c68-93eb-79804313ab15",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aaf6b2b9-5b8e-4867-ba99-e9a33931b78c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35c70c77-dcba-41b5-b390-6b19f982d979",
"db_currency_id": "01a6167b-e00e-489c-877b-5e7ad379362b",
"db_language_id": "ebe0ce36-ab1c-4a4f-a497-d428bbdf847e",
"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-26T19:44:15.3357753+00:00"
},
"modified_dateutc": "2026-06-26T19:44:15.3357753+00:00"
},
"marketing_segment_id": "2be01204-7a55-4d62-89ed-de24956b7dae",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "41dd37ae-6aaa-4812-8d95-42114db6f9e7",
"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": "809c9e9b-6513-48f8-89cc-5ddf6be856c6",
"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": "939d4d54-9f1a-46f5-b1bc-6b20bf5cf2ad",
"db_country_code": "sample string 28",
"feelist_id": "78253d13-2897-499e-8138-afd785091a06",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4f53a734-ade3-42e6-82b8-1fb15902b365",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "672b96c3-b7f9-47cf-82b0-722b5674616e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-26T19:44:15.3357753+00:00",
"db_currency_id": "aeb7e84b-a9a4-400d-8bff-9990820324b9",
"db_currency_code": "sample string 10"
},
"company_type_id": "9dea8dc3-198c-43b6-9e22-fd5a209d19b9",
"company_type_name": "sample string 32",
"company_type": {
"id": "b58318fd-f3df-4d21-9a0a-5c32a25edf3e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c1312c7f-7bc4-4f8e-87a6-f442d831cd1d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "394b332e-179a-45b8-a213-d23f309de8d2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cb4dbc0e-adb3-4489-bdbb-b7dc6aef28ed",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0f9fdfa9-d7f6-48e0-8e9f-d42c672b85d3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "869b92c7-7a31-4625-ac12-379f22e5531c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-26T19:44:15.3357753+00:00"
},
"company_sector_id": "3d2958b1-e5eb-4461-8120-d4c8d93149d1",
"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": "9ed44e6d-28aa-4f40-99ac-8b0677673867",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e7c7bb7f-6432-405e-8e20-c44e35038704",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ba79261a-c2ea-4827-ae95-ae1bce498fdf",
"account_manager_user_code": "sample string 56",
"company_status_id": "1ad8c57f-1240-4326-9bb0-e249dd4c099d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-26T19:44:15.3357753+00:00",
"id2": 60
},
"db_language_id": "4c02f8b1-1d31-4ca8-a97d-8047e2cfd750",
"db_language_code": "sample string 7",
"db_title_id": "11e5c817-8417-4bb9-9da9-956c66a54616",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-26T19:44:15.3357753+00:00",
"create_date": "2026-06-26T19:44:15.3357753+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-26T19:44:15.3357753+00:00"
},
"modified_dateutc": "2026-06-26T19:44:15.3357753+00:00",
"id2": 22
}