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": "77167a87-d526-4852-aee8-56a08ee2cf45",
"_parent_id": "013f3f7d-46cb-4d6f-834d-caa71b0ab8c3",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "4787f5f5-b6ba-449c-b169-0885400f22cd",
"company_id": "58676674-bc7b-48b5-a332-d2554db4c914",
"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": "5e784d44-884b-4dc3-8a30-008d7f1631e3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "637b2517-75c6-4d09-89d7-42de840eb6a1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "aeafd648-71de-45e9-be86-a1c7780a0955",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b020a683-b4a6-462e-8c69-7d4ac219b7b8",
"company_code": "sample string 5",
"company": {
"id": "f6273d57-1aa9-4a8e-a499-193bf8e94057",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-10T14:40:19.8124997+00:00",
"sales_territory_id": "c5df0ae4-95cc-410f-9f19-da482a433391",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "dd77fa02-8e94-4fb0-b499-7ec98bb8d0c8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c3db5b3c-dac0-442d-aae0-4f3f6388ca89",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f3e2ed39-5c0a-4f73-b579-1aaf704eb218",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cbbd915-0715-4e27-846d-b111b1d2f349",
"db_currency_id": "d5be4e16-2cac-48d4-b385-8bbb7833a3ad",
"db_language_id": "e4424e03-ef91-464d-9ecb-d33066bc62a8",
"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-10T14:40:19.8124997+00:00"
},
"modified_dateutc": "2026-08-10T14:40:19.8124997+00:00"
},
"marketing_segment_id": "ec28fcb2-0833-4b30-8ad8-a0ac197e14fd",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3786ed6c-8311-493d-8d96-e1de1d93529d",
"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": "cf9e5bad-c245-4267-8757-19f024d9b041",
"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": "d9c12bc8-a18c-473d-b7fb-1f5844e169fe",
"db_country_code": "sample string 28",
"feelist_id": "d3052685-3f70-4ffa-8acd-03246c9eaf60",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "01ff704b-065e-4f22-b218-07821b0f443b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "52a5cece-924c-4715-9bb7-b1e6523f372e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-10T14:40:19.8124997+00:00",
"db_currency_id": "481d1d5f-5ca7-4415-a0a1-4c5d97d405ea",
"db_currency_code": "sample string 10"
},
"company_type_id": "a0d4a1c2-483e-43d4-af96-89f66ad2615a",
"company_type_name": "sample string 32",
"company_type": {
"id": "907de9cb-ee05-4ccd-a53c-c72189b6cf19",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5bc43852-b0e5-4c36-8ccd-0a6c4567aae6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ac82fa1f-4ab4-4ae8-aac2-b30bb56b3efd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8f4605f7-dae9-4595-95e1-9004a8715e73",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "52350980-a465-4c24-ba19-1f557056428c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "85676aaf-a98a-40b7-91b0-a2b957a37880",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-10T14:40:19.8124997+00:00"
},
"company_sector_id": "f74c37c2-5b4b-4302-b196-610852ba41e3",
"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": "7429c2aa-6b81-48fa-868c-7a5015f9a6eb",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d6c841c2-9b1d-4c88-92ab-79d5ac63b866",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "74095700-b158-4d99-b745-174b7d8668c1",
"account_manager_user_code": "sample string 56",
"company_status_id": "5836f405-aba9-40e1-93e4-748db4f425e6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-10T14:40:19.8124997+00:00",
"id2": 60
},
"db_language_id": "584b54fc-e675-4f02-863c-d1c50442db05",
"db_language_code": "sample string 7",
"db_title_id": "210694db-afa4-43d7-ad18-27889511b7b2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-10T14:40:19.8124997+00:00",
"create_date": "2026-08-10T14:40:19.8124997+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-10T14:40:19.8124997+00:00"
},
"modified_dateutc": "2026-08-10T14:40:19.8124997+00:00",
"id2": 22
}