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": "0b34f1b3-0624-4719-82b7-59fea8f6025a",
"_parent_id": "9c980fd3-806e-4646-a8ed-3df915c656df",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "48cb8427-4b7e-487b-84df-04603410f55b",
"company_id": "1e4b7720-8871-4729-8705-6d30b9f9f985",
"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": "db9f836e-de11-4733-aa67-c2282c19a68a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ed971a1e-6588-4b05-96e1-f39991077718",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "29cd5a80-6c8d-4c6e-a695-ed7316e19ca7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0448ee3a-43eb-4e87-a65a-156e709cc8c2",
"company_code": "sample string 5",
"company": {
"id": "8c66cf66-5a47-4fd6-8105-5f5bee36d876",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-27T22:58:03.8806251+00:00",
"sales_territory_id": "29a2a167-9c38-446d-aed1-cb8dd9cfb128",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3e1aea03-a179-4bfe-adfa-f5302b7cb7ca",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "51dfd2dc-0a6a-4db5-9b10-efd7241964ae",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1f9ccd96-7143-417b-9871-1c89b1ff0ec6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a21203b-5e89-462c-8258-504259be6aa9",
"db_currency_id": "6bfc575b-0084-43b2-9afd-954d25d99291",
"db_language_id": "6605ab09-7d43-4704-964d-a4ebe6e6dd97",
"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-12-27T22:58:03.8806251+00:00"
},
"modified_dateutc": "2025-12-27T22:58:03.8806251+00:00"
},
"marketing_segment_id": "c88835c3-a3c4-4a11-ba5a-fe31b7ff425d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6f0c36a9-2df8-43c4-9eca-29332505c7d4",
"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": "d6662847-51c8-4f25-86cc-129126a5a020",
"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": "21df78fd-cf24-4f0a-8d51-25876d2132cf",
"db_country_code": "sample string 28",
"feelist_id": "660e1873-dcab-4e60-a0b6-3ca0a0fab4df",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "18d29896-6df8-461c-afaf-b4e60c39a119",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ebd0d1fd-7e31-438d-8c65-7b66edb4a718",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-27T22:58:03.8806251+00:00",
"db_currency_id": "b95ecb55-9996-4443-9a32-dca33b46f7fb",
"db_currency_code": "sample string 10"
},
"company_type_id": "09775b98-0596-4802-8ab2-ee471d866e41",
"company_type_name": "sample string 32",
"company_type": {
"id": "da1185dd-f479-49da-afdc-dbce95b13850",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5e0de52c-75a3-41c4-8852-e7ac5b450f96",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a62e7e15-662c-45a1-beed-ab4f72893bb0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d124ae81-2218-48aa-97d1-21eab9854c96",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f3b54952-4efb-4873-a55a-3fe2efdefaf2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "88fc8d18-741a-4188-9bee-0450f5f71a1d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-27T22:58:03.8806251+00:00"
},
"company_sector_id": "35565a8f-15b8-462d-82f8-8b51e66e8514",
"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": "9b5a29c0-6227-4b29-9756-03df288f47ac",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "50e3a8e3-b325-4cd0-b8f3-9504cb01f56e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "19a7a063-c81b-44f8-9fb9-a26ebea3a9c3",
"account_manager_user_code": "sample string 56",
"company_status_id": "54124e9b-2ce5-469b-a3a5-90a1e2276fad",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-27T22:58:03.8806251+00:00",
"id2": 60
},
"db_language_id": "55af63fa-fcab-4200-bc4f-0e15d99914b4",
"db_language_code": "sample string 7",
"db_title_id": "5f24f086-a36e-4b8d-b6a5-746a0973bfb7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-27T22:58:03.8806251+00:00",
"create_date": "2025-12-27T22:58:03.8806251+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-12-27T22:58:03.8806251+00:00"
},
"modified_dateutc": "2025-12-27T22:58:03.8806251+00:00",
"id2": 22
}