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": "ea3186d2-abdc-436b-b7c5-b6eb554de660",
"_parent_id": "4183893f-1f62-4429-a7aa-6529ea123436",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "25a1797b-7dc6-4de4-b811-eb311cd11307",
"company_id": "972a917e-72be-4b9e-86e5-39631cd80856",
"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": "32e18143-db54-42ac-be9d-0ec4e7fe49a8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "50a91ec5-cb9c-446e-a492-371f38974124",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "b0a1446a-f3ca-4251-a4db-accbfbbdad8d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9200d6e1-1194-45bc-a046-7d0dbfed504c",
"company_code": "sample string 5",
"company": {
"id": "0789b211-9f20-44f6-8e65-0ce714f8eeea",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-11T06:10:03.7274183+00:00",
"sales_territory_id": "c775891a-ce07-4282-a015-3b6a31636168",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ee2c97ec-eb44-4275-bdd4-4f473ed762e2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3ee8e996-20b2-45fa-8eb7-628b71cd85d7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fc031242-04b6-4311-a365-12074a2598f8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6724895c-1d9e-424c-a196-63dbb88c5add",
"db_currency_id": "cc3263c0-02f4-429b-891d-36b1e62fa056",
"db_language_id": "c536de14-a5c1-40c3-88ae-8adeec88e4e2",
"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-05-11T06:10:03.7274183+00:00"
},
"modified_dateutc": "2026-05-11T06:10:03.7274183+00:00"
},
"marketing_segment_id": "fac1e4a7-268f-4618-b48a-a7f08fc385c0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "af5ebc0a-70dc-4341-987f-452bb534eb7f",
"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": "885165dc-aea2-47ed-9392-7d2adc06f13f",
"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": "f6459623-99c3-45c0-a0f0-926dd0730ca0",
"db_country_code": "sample string 28",
"feelist_id": "25101961-2d93-4349-92ec-da24d18ed120",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1df5cfcb-6458-4bdf-ad0f-7738f4bc2c65",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7f8f66ca-d7f9-4cef-9940-696f886a3078",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-11T06:10:03.7274183+00:00",
"db_currency_id": "702612ea-f338-4ef0-b19a-b1fc0cf7a638",
"db_currency_code": "sample string 10"
},
"company_type_id": "d4bedbc8-ac07-4162-af66-bf153ec8cf89",
"company_type_name": "sample string 32",
"company_type": {
"id": "923a1eab-be58-438f-8c73-97e6f0fe53bf",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e6b9b23f-3af2-4bb5-8a2b-af82b04df8cb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fcd23cc7-53ff-4a0c-8f9c-90783b04b2cf",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0e3ccd67-847a-44ab-9795-7c736396461b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bdf48705-411e-426f-80c6-aaab2b569f6d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f97b51cc-593a-4771-ab9f-8fc64fccdce9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-11T06:10:03.7274183+00:00"
},
"company_sector_id": "d1ea8960-2487-4208-893b-197faa398347",
"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": "b40246ac-3e64-43ea-adeb-965bbf1a7bc9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "15e216be-2b5c-42e0-8e2b-e79d98408581",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "76549131-5367-4be9-b713-fceae20950ba",
"account_manager_user_code": "sample string 56",
"company_status_id": "80b89adc-c736-4e58-995d-34276d9850bc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-11T06:10:03.7274183+00:00",
"id2": 60
},
"db_language_id": "92a531e5-46b0-4c21-b61c-94e3c06ac3d0",
"db_language_code": "sample string 7",
"db_title_id": "8fa6637c-bb0a-4cf0-af3f-b974b9f66ade",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-11T06:10:03.7274183+00:00",
"create_date": "2026-05-11T06:10:03.7274183+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-05-11T06:10:03.7274183+00:00"
},
"modified_dateutc": "2026-05-11T06:10:03.7274183+00:00",
"id2": 22
}