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": "e0379a37-492b-4361-9f03-46b808ab3cb3",
"_parent_id": "f91a0071-cfe0-4eac-8c06-4e13a8d3f670",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "bec44b25-b4c4-4bf9-83ed-23c7b9737e70",
"company_id": "b3bd674e-9728-4f84-a99a-601fcfa68d38",
"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": "9d7f7a35-60cf-4787-8184-a810bd662dd7",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "74892f86-2366-41a5-887a-05e1c28d2b0d",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ca73aa92-82cf-4352-8947-e16727413c8b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "242b55e7-d01e-40a4-a653-8e146d4610e3",
"company_code": "sample string 5",
"company": {
"id": "e9e25877-b01c-4a5f-b517-f64a77b7a9a2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-15T22:24:10.1984353+00:00",
"sales_territory_id": "c350a3db-e4b9-489d-802c-0d12485ba951",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "00e8036d-6c26-4840-a4bc-f1e2d7a91fab",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "afc89b8c-9392-4a33-b997-00761348a75c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f67035f3-64d7-4d56-a3c8-c4a5166100d3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16b1da71-3f43-401c-9204-aca11a42e297",
"db_currency_id": "8e896515-2385-4848-afe0-993fc340d90a",
"db_language_id": "30beeb1d-7e3a-47d1-90e1-ede8fa98fc5d",
"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-10-15T22:24:10.1984353+00:00"
},
"modified_dateutc": "2025-10-15T22:24:10.1984353+00:00"
},
"marketing_segment_id": "b19784e6-b9b1-4e59-bc92-573910d52896",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "83cb32be-2f4a-4f17-9f50-03e04b74f678",
"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": "0871b212-eafa-40d6-93a6-98f9c2bb0b52",
"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": "455ed67b-79f8-4ec3-a846-cb7ab4fd736d",
"db_country_code": "sample string 28",
"feelist_id": "87d401db-4494-460f-beb1-3cbbfbffa49a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8bf7fb62-b40f-4bfb-8315-b06948ccea34",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9248faf4-bbbf-4f16-91c4-992b6003e7b8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-15T22:24:10.1984353+00:00",
"db_currency_id": "c1034636-c718-4bcc-8fd8-8d0201bdbe8f",
"db_currency_code": "sample string 10"
},
"company_type_id": "85291627-bc0d-420c-80cc-4a60f68010d1",
"company_type_name": "sample string 32",
"company_type": {
"id": "410833db-2282-4cb4-945e-7567fb5a0df4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "639cde72-de29-44ef-a487-df19f7da274b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "42fe12a0-a5de-4a29-96e7-b231ef00f0c9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "79490020-20d4-440c-8ffd-3638fa4920ce",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a3d841ff-311a-4dc0-b8fb-f831ba30fe88",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e6ed21b2-7071-44bb-bf9f-d2103f9f8512",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-15T22:24:10.1984353+00:00"
},
"company_sector_id": "80c5bbd2-34d8-4334-8655-500e4db4f655",
"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": "00930343-277d-4064-a704-cdad7c0bfab2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ea3b810d-0e6e-404f-9ef3-7eb5fe6ee113",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1ad99ac6-7d31-4d8b-a108-796e8adbe7e2",
"account_manager_user_code": "sample string 56",
"company_status_id": "c4fe0ab7-9100-45bb-955a-13c38a1a89d9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-15T22:24:10.1984353+00:00",
"id2": 60
},
"db_language_id": "faf1a3ee-f4fb-4743-bd6f-30eec6be4fe4",
"db_language_code": "sample string 7",
"db_title_id": "f513320c-6b22-4fec-a912-be5aee7eb2f5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-15T22:24:10.1984353+00:00",
"create_date": "2025-10-15T22:24:10.1984353+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-10-15T22:24:10.1984353+00:00"
},
"modified_dateutc": "2025-10-15T22:24:10.1984353+00:00",
"id2": 22
}