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": "fae2ebee-9284-41da-b4a0-9d4ff907c6f9",
"_parent_id": "84f78122-8998-4b2a-a4de-d97420e18d43",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ca2b4731-c001-4c65-bd50-c72ddaa83756",
"company_id": "8bf48651-579d-4daf-8a30-0aff5171d5ec",
"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": "06586ba3-38c3-45f0-9bf7-d39d85e541ba",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "de27430b-279c-49df-90a1-1e46d3bc7dce",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "71d1803e-8b6f-43b9-829c-12d3f1b6a427",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "20ee4a8f-3e13-4f6c-af07-3741dafc61b5",
"company_code": "sample string 5",
"company": {
"id": "30a8a82c-5b29-47f3-997c-6e39737a869a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-03T21:11:34.3815019+00:00",
"sales_territory_id": "5632b066-fa09-4e59-9be8-2f91dd87a1c4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "59fd3976-c4df-460b-ac36-92f30bd1a8d3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b65945a4-019a-4299-82c5-6ef9a6cf02ff",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9774fe3f-fe76-4515-ac28-0cee30482e7b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e631f54e-ab02-411e-9a25-f94168487dd7",
"db_currency_id": "6f4e2c58-5902-4591-9f9d-5f51e4d552ef",
"db_language_id": "4e9da048-b949-45cc-8857-a09f38bd8337",
"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-11-03T21:11:34.3815019+00:00"
},
"modified_dateutc": "2025-11-03T21:11:34.3815019+00:00"
},
"marketing_segment_id": "7830abe0-4243-4e5d-8807-61152b7330f7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4892f679-0c13-48d1-b9f7-de6fad8c7705",
"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": "5c0d3bc7-126f-4aac-bb65-961f860c9a28",
"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": "3f903da9-0307-49fa-bad6-62a47083e670",
"db_country_code": "sample string 28",
"feelist_id": "be8fcde7-5c34-48f9-9caa-e8bc6e6a6431",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8fb82d25-0e88-4608-856f-28f866a7a69e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c75471f0-14de-4407-9ad1-140dd2a1b6e8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-03T21:11:34.3815019+00:00",
"db_currency_id": "2b645f46-2e38-4b61-b4e4-15d1124ac1e5",
"db_currency_code": "sample string 10"
},
"company_type_id": "2dfae033-35ef-4963-9033-9a1fb1759682",
"company_type_name": "sample string 32",
"company_type": {
"id": "678b8bfc-6b5d-4139-bfd7-eb1883783ee3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8d344bbf-f9db-4e15-8751-70e06bd680df",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6d25c3f7-f0e5-4890-8ca5-aa5dfdcd8132",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e451242b-93ce-444d-83f6-cf2c64d78c06",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "571e994b-6bbb-4819-a336-7a6acd0d2b9d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "49fa3ec9-7691-406e-b009-5c2e4b3fc8c3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-03T21:11:34.3815019+00:00"
},
"company_sector_id": "fae6c83f-0bea-49aa-9956-b1b1127551f6",
"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": "ab4df8e7-9175-4ebe-9d84-bb17547af09e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "933583ca-d408-4cb9-bfee-726f78e61105",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d4610fff-3c3b-4aba-a60b-1a27b8cc265c",
"account_manager_user_code": "sample string 56",
"company_status_id": "a864e442-7d7b-4045-bc44-b6986a4aabd9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-03T21:11:34.3815019+00:00",
"id2": 60
},
"db_language_id": "4e69e777-bea9-4be9-b201-4662c2fe812c",
"db_language_code": "sample string 7",
"db_title_id": "986d0d00-9492-45bc-b43f-941e96a2697c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-03T21:11:34.3815019+00:00",
"create_date": "2025-11-03T21:11:34.3815019+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-11-03T21:11:34.3815019+00:00"
},
"modified_dateutc": "2025-11-03T21:11:34.3815019+00:00",
"id2": 22
}