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": "b56ca8a9-42f6-4d6b-a77f-ee27d7bf1db9",
"_parent_id": "f14c7a79-b5c2-48e1-9828-6996f4ae91f4",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "09144867-ad3e-4261-b91f-35669dc8710d",
"company_id": "45657b7a-03d6-4f9e-b24e-3473b04f275d",
"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": "47654ec1-e00a-48a2-a838-4d1d3ac5d42b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "48d1d146-b266-466d-9749-5e42d2aef307",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "8467eb0f-324f-4447-80c8-9bd401e0b319",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e2bc7cd4-608d-411c-afaf-6446b4917902",
"company_code": "sample string 5",
"company": {
"id": "9458d960-0390-4fa8-b9ad-282843c1c849",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-09T05:21:34.3924263+00:00",
"sales_territory_id": "f3f299db-e0dc-469e-b6c5-ba9d341fb238",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f906e441-0a38-4800-bb2d-6a87472623da",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6e810ada-2203-4cfd-8e92-738ac84f4b84",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d386447c-1a67-4f55-9afe-b27249e5d9ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c4d26dd1-77a7-4bcb-9b75-cbbb791add1a",
"db_currency_id": "e7080477-2fdb-4cce-94f1-5a5d14b55c4a",
"db_language_id": "18e5175d-783c-4223-9c8e-2ebdfc9b2960",
"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-12-09T05:21:34.3924263+00:00"
},
"modified_dateutc": "2025-12-09T05:21:34.3924263+00:00"
},
"marketing_segment_id": "db0f1f56-49c6-42f8-a6df-edef51e5684d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b98930a0-a644-4844-a3c9-14394a137225",
"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": "73b032cd-d0f3-473d-a34a-7fb71109764b",
"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": "299e91cc-718f-4c5b-b1c6-1f4188c03e73",
"db_country_code": "sample string 28",
"feelist_id": "307f494e-1bf9-4c8b-a821-f27e4306d930",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c1459eeb-236a-4231-b447-cbd942afacf9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c3551371-954c-477c-9844-4e062cd1421a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-09T05:21:34.3924263+00:00",
"db_currency_id": "b65e2d55-0d56-4e49-a193-e94e819cbb4a",
"db_currency_code": "sample string 10"
},
"company_type_id": "bab47f57-7ded-4280-8e28-a9ea3bce0e7d",
"company_type_name": "sample string 32",
"company_type": {
"id": "b2420775-dfa3-434e-b650-033cee6261db",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bd324323-cd6c-470d-b1ef-942a94347a21",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ba838367-c5a9-48e8-afc0-e6845fd21757",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5bad109f-68a8-4fb5-b131-83aea3df5673",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fe976964-3351-402d-a466-2eca11848145",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ef223341-00ae-408e-8151-487917afeaf2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-09T05:21:34.3924263+00:00"
},
"company_sector_id": "0513d5ff-d206-4679-9408-caff5d1d6583",
"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": "6a5c4b5e-7fd1-421f-83f2-1865b3a9f5f9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "15564dfd-d7b3-4007-a2b8-acfb2e17cf9c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b50bb55d-7660-4bfa-94e0-76b4205a69e6",
"account_manager_user_code": "sample string 56",
"company_status_id": "12f4851c-f30e-437e-aaec-657550c06368",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-09T05:21:34.4080505+00:00",
"id2": 60
},
"db_language_id": "34aed309-d908-4316-ac25-508e46edf486",
"db_language_code": "sample string 7",
"db_title_id": "bccfa093-ef7f-4bbc-8a30-7c6c11a5e1cc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-09T05:21:34.4080505+00:00",
"create_date": "2025-12-09T05:21:34.4080505+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-12-09T05:21:34.4080505+00:00"
},
"modified_dateutc": "2025-12-09T05:21:34.4080505+00:00",
"id2": 22
}