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": "80a4b574-f60b-4e52-9835-52f1072d5fb9",
"_parent_id": "8648b058-68db-49a0-b7da-ae360113f823",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "694d43f1-282a-48ec-8d72-db914d66cede",
"company_id": "81a2c3f7-a2ca-487e-a448-fc60bcdbbdbe",
"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": "d6750b0b-b324-41f5-ae66-9045ba9dc8f2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c04cbdc7-11f9-4847-8ccb-d7f0c9b9a7ac",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "97b00c27-4296-467a-9074-6f353f86dcda",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "787559d0-a53e-486d-a34c-16e960982404",
"company_code": "sample string 5",
"company": {
"id": "677cfda5-3a8a-45c9-89dd-04989fb2ea06",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-01T01:04:21.6562317+00:00",
"sales_territory_id": "4b9416e6-48a0-4b08-8c82-60df3a90b89e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6605e7ee-81e4-4fc4-9386-a1a30f484699",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e8b56063-f25d-4b94-a833-13f0806f6db0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a4b13038-163e-4e85-bbe9-cae9accda7da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a6580367-1232-472a-8a90-aa838b9fd055",
"db_currency_id": "32effdd1-da4e-4e2f-8651-5c3333cb1b37",
"db_language_id": "a472dec1-d5e0-4d8a-add6-16178cf30cfb",
"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-11-01T01:04:21.6562317+00:00"
},
"modified_dateutc": "2026-11-01T01:04:21.6562317+00:00"
},
"marketing_segment_id": "2ee83022-867c-479f-b1eb-f008cff7c83a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "13939e8c-9e7b-4faf-b01e-9b2f8be46407",
"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": "88559600-d227-4dcb-bd7c-8b9bea735eaf",
"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": "b8c66697-0e61-474e-b200-06511c2fde4e",
"db_country_code": "sample string 28",
"feelist_id": "5e9487ec-331f-4508-8f81-c4c869ef3c12",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ac6b091b-0e4b-439f-aad0-29d9e5a6e0ba",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "82b0df65-7c4a-4eba-aa46-ef3540efabc2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-01T01:04:21.6562317+00:00",
"db_currency_id": "462aac81-26ec-4b4e-b016-bb9c5699bce3",
"db_currency_code": "sample string 10"
},
"company_type_id": "c6233027-e820-4a42-92f5-2e7c9529a43d",
"company_type_name": "sample string 32",
"company_type": {
"id": "2d921e42-47b0-4e8d-a696-1d26761872dc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cdc2af52-7309-4352-9fd2-5ab36f54c330",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ee79e5cf-0238-4884-bd08-ee73037de200",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ff7ce292-5046-4ed7-9345-a42a488a5a0d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e4d7b34e-b2d0-4709-b05e-ae25c77a4b2e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "682a3cf6-9ae2-47ff-adad-118508a14b0f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-01T01:04:21.6562317+00:00"
},
"company_sector_id": "7b31de1d-0b07-4d27-a169-366eeb3b1b6d",
"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": "c3e8a3e9-edf3-4dca-b2be-ce06f7eb6a4a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "42147df2-e981-4761-8db9-e80df885551d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a29b64bd-ebeb-4ce2-90af-bec679cb9f34",
"account_manager_user_code": "sample string 56",
"company_status_id": "2fa78928-a1e9-4b53-9f0d-abe70af0d6bd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-01T01:04:21.6562317+00:00",
"id2": 60
},
"db_language_id": "52e91a40-b441-4e32-893d-37e5e9ce86c5",
"db_language_code": "sample string 7",
"db_title_id": "ea65c778-e0c4-4a5b-9a49-d4c8317fa001",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-01T01:04:21.6562317+00:00",
"create_date": "2026-11-01T01:04:21.6562317+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-11-01T01:04:21.6562317+00:00"
},
"modified_dateutc": "2026-11-01T01:04:21.6562317+00:00",
"id2": 22
}