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": "bf6be767-af3e-4dea-be6d-c7294721017f",
"_parent_id": "f61b406e-a59b-4296-8b47-8f80c04debdb",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "5600bf1c-bc73-415d-8154-4d0c64110d07",
"company_id": "98e489ab-b6fe-4370-9ca8-b828bbfc2634",
"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": "b7cd4dfb-720c-4b30-ac8c-9e1004a1d7f3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "cf6bdeda-640c-4d35-9459-2bf53ec6da2e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "92190804-4959-4287-ad04-6db6d37c08e1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b56eae26-e131-47ce-9869-af13a8e0c7db",
"company_code": "sample string 5",
"company": {
"id": "e9f5ce22-07ee-42a5-81ae-f8efb0cac61f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-31T23:10:22.340655+00:00",
"sales_territory_id": "00300bba-9122-4c42-9a02-41eb1a21a5a8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8e5473b6-fb67-4267-b648-5adad4d14c3e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4444e739-1300-43ed-ad0d-b29250c8b445",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c2c4ac90-479f-49f5-83cd-4c6aa7977a38",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da10b700-f037-4a1d-97c5-475edd4a8e32",
"db_currency_id": "54762684-e140-48ee-88f4-5b6046bf8521",
"db_language_id": "7fcb2b29-9884-43d3-afc9-efb76c462076",
"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-31T23:10:22.340655+00:00"
},
"modified_dateutc": "2026-08-31T23:10:22.340655+00:00"
},
"marketing_segment_id": "d34bb97a-fec9-4329-a606-0c6b6636f56c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0280d708-343c-4e88-ad29-f89138cd1281",
"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": "40027ff9-cc3d-43cb-9bda-5c98f17784cf",
"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": "e9b903df-9be3-45f6-9709-a8a464a576bc",
"db_country_code": "sample string 28",
"feelist_id": "bebf7337-c17c-40e5-9e0c-8b5f6330cbc0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "be63f94c-7fe2-455a-b484-47122e18a8f9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "348e19e6-b8d0-45ab-964a-da7b8b4acc7a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-31T23:10:22.340655+00:00",
"db_currency_id": "eaadb7c3-4903-4c2f-9e40-6c91eac30bf9",
"db_currency_code": "sample string 10"
},
"company_type_id": "e634f8a9-c7ac-4f6d-bed6-192696563fa7",
"company_type_name": "sample string 32",
"company_type": {
"id": "bf84301d-8c20-449e-bf84-bb2e69f43a53",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "28b5da3d-287b-402c-b058-7e5fd993c19a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c6069761-a159-40cb-b7fc-68bddc44bf1f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "60b94924-4a9d-4ba7-bc41-d36ac41e886f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "016127ba-94e2-4f95-afd3-e8ed7949ba50",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "26d6a9dd-2ee1-475e-882c-48dcf963c115",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-31T23:10:22.340655+00:00"
},
"company_sector_id": "a8937161-24b3-4df3-9d4c-e8d4ea38e66b",
"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": "ee4a8ad4-219f-4176-8e5d-4b69de8bd7c6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "180f61fe-123d-4c81-be38-78471aa0f629",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "91f6887c-01ee-41d9-984a-740056e7ef1b",
"account_manager_user_code": "sample string 56",
"company_status_id": "0b7ad0e5-435f-44af-ba65-ed6ddc8193e3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-31T23:10:22.340655+00:00",
"id2": 60
},
"db_language_id": "8fceb72c-acfa-43f2-a732-390ec084515a",
"db_language_code": "sample string 7",
"db_title_id": "f218a75d-bc8c-4fb9-b55a-aa0125e240e7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-31T23:10:22.340655+00:00",
"create_date": "2026-08-31T23:10:22.340655+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-31T23:10:22.340655+00:00"
},
"modified_dateutc": "2026-08-31T23:10:22.340655+00:00",
"id2": 22
}