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": "e6ee9443-6463-4d80-a962-af499ff91d5e",
"_parent_id": "f04a45b2-16c5-4ab1-8102-d4d63d725983",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "17fd9de6-9d72-48f7-9689-7c3941779d19",
"company_id": "e0d8b7a3-0bf5-492a-82c9-3681e1d0f033",
"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": "7238f50c-9361-46e2-a701-7a9cda98a802",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "51667770-d745-408b-99ef-479f7c83a304",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a6165751-df6a-40d6-a508-96490cdf14c7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ac3a3bfd-a171-4933-9b27-70659604de85",
"company_code": "sample string 5",
"company": {
"id": "5cca7195-67b0-4aac-8f76-f4476470cfe7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-28T06:01:46.1491941+00:00",
"sales_territory_id": "37732bae-92b0-42ee-9840-a7b9897bcc46",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9ea8a833-e497-4c94-96a2-7fee24e6c186",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0b53f99b-6e5e-4d50-ad21-ca8174950748",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f2ec4c45-6fed-4c29-b4c6-351ae5f88117",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac82e76f-2828-4764-b847-0cf298b93b2f",
"db_currency_id": "20fc6643-80a7-4a56-88d3-5235a07a772b",
"db_language_id": "aa48ab6a-4303-4851-91fb-aaabdc087e00",
"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-09-28T06:01:46.1491941+00:00"
},
"modified_dateutc": "2026-09-28T06:01:46.1491941+00:00"
},
"marketing_segment_id": "aeab58d5-9c03-4de7-9495-663353f6349b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c248c32b-d29e-427e-97c4-63d2b34bc62d",
"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": "388137d4-1bd4-4bc4-bfb3-a55f00b75082",
"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": "46953ec0-49ec-40fe-82b1-45bbe7f1f9a0",
"db_country_code": "sample string 28",
"feelist_id": "e4f017da-bda0-4b5a-97ce-f74267021b51",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b2e2d80f-618a-4e1d-8dbe-272e7b37dc7b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "45890b6b-4708-42ab-ad8d-d0f84e747718",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-28T06:01:46.1491941+00:00",
"db_currency_id": "95cf7de8-96f3-464d-b9a9-eb7841c93dc7",
"db_currency_code": "sample string 10"
},
"company_type_id": "133b1d19-cb12-42af-bde1-8c9b716caf88",
"company_type_name": "sample string 32",
"company_type": {
"id": "1838d0ad-4398-4687-be98-c29ab856ee81",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7472757b-720e-40de-abb5-bf5130613c04",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1435ea32-94d7-4043-9d87-ff64ea950edf",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "636bad51-d6ce-40d5-a033-d910134bf32b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "45a38844-5cd0-46a8-923e-14888e777815",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a6b93ea2-1528-43cb-a44f-5bbad0223cba",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-28T06:01:46.1491941+00:00"
},
"company_sector_id": "c5b42659-924d-47d6-bb7e-7eeddff791c8",
"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": "64ace1eb-5477-4712-9047-286a1b8073a9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "444654e2-3898-4169-a79e-1bde507df988",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2d8f0d21-23dc-456b-8c6e-9de8accf4f95",
"account_manager_user_code": "sample string 56",
"company_status_id": "83b0cb46-c849-4190-a128-79becee4391c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-28T06:01:46.1491941+00:00",
"id2": 60
},
"db_language_id": "ad45e46a-0766-42da-8fd4-90784d252f46",
"db_language_code": "sample string 7",
"db_title_id": "b752812c-3d47-4a48-b001-a942baf1fa13",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-28T06:01:46.1491941+00:00",
"create_date": "2026-09-28T06:01:46.1491941+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-09-28T06:01:46.1491941+00:00"
},
"modified_dateutc": "2026-09-28T06:01:46.1491941+00:00",
"id2": 22
}