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": "b985a5e7-5740-4c5c-85e3-bd97ead226ec",
"_parent_id": "6eb3da74-351f-4411-9cdf-90973f382742",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "40ec1d39-f438-4938-882a-f48909e27911",
"company_id": "81054e5a-27be-425c-bc60-e4d343a391b7",
"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": "6b47ebb6-0f27-4ab3-8f23-1cb425797e57",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "796a3606-b903-4b6a-bfa7-d9996d80fede",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3c987412-f9bb-44d8-bcb8-0392ed1c1f60",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "83eda8ce-7bb4-44ea-9eb1-754af0d71f83",
"company_code": "sample string 5",
"company": {
"id": "055e981c-6856-4f9c-84b6-4043f455e3f9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-09T05:11:27.2978433+00:00",
"sales_territory_id": "485b0967-5de6-4b4d-9b2c-f6640551b6bd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3d518132-b9f6-4f4d-90c6-d1329b1c4fb9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a9434620-b4d5-48f6-84a1-fd652fa3b215",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "89c4fab2-cd5c-4173-9385-0cb4715b7d06",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d6aa977-0a18-499b-8f16-3d9e249d2f78",
"db_currency_id": "b5d83f9d-90de-4aa9-ad24-6b0d30136278",
"db_language_id": "7b9cc8c3-e63b-4911-8462-b93169df0991",
"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-02-09T05:11:27.2978433+00:00"
},
"modified_dateutc": "2026-02-09T05:11:27.2978433+00:00"
},
"marketing_segment_id": "8dae2024-7f56-4165-bf6f-2d9b9ae1db60",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "94271da4-e34b-445c-88a7-38b112825097",
"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": "a6867a37-7ef7-49c6-8287-eac6dea11714",
"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": "4b855599-fb7f-41be-b833-7096da0266bd",
"db_country_code": "sample string 28",
"feelist_id": "baf83d87-824a-42b0-9376-16f89a4ef376",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1436544f-f296-4f33-b3db-d772d9e4ce8e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c5d17cd2-4f45-4b82-bdf4-fd049e33a405",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-09T05:11:27.2978433+00:00",
"db_currency_id": "a0fd4d86-3f84-4e96-81c1-3b0fa43aa564",
"db_currency_code": "sample string 10"
},
"company_type_id": "55256c29-aca2-40f9-831e-659ddc44972e",
"company_type_name": "sample string 32",
"company_type": {
"id": "347910c5-9e4c-4c91-8037-d229e1073499",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9c6ada36-acd0-4558-9c5c-072c8aea2711",
"sales_organization_code": "sample string 5"
},
"db_language_id": "39bf3954-663c-4dc5-a347-ca5f6bc35a07",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e6465838-7221-4a2b-9916-b1ee13d74c04",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5b83ec08-5981-4ad1-b8db-b8bdd0a88059",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "69d3fc6a-375e-426a-bc06-23c1a41c60c3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-09T05:11:27.2978433+00:00"
},
"company_sector_id": "29a9d905-629a-4cca-ac12-73d42f2199d6",
"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": "04030ab8-382f-4df9-9e2d-89e1bf8fe0a4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3fe110a8-f901-4bcc-bddf-15b8fb34ed5f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e2acf8d4-2756-42f8-a1c1-24f88a93eea2",
"account_manager_user_code": "sample string 56",
"company_status_id": "4c3935f3-e00c-4148-98df-9841ce0c321a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-09T05:11:27.2978433+00:00",
"id2": 60
},
"db_language_id": "77f985fd-cb98-4b45-bbce-dcd6449c2aef",
"db_language_code": "sample string 7",
"db_title_id": "44c9c634-59c5-42ee-9795-decd8f2fa775",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-09T05:11:27.2978433+00:00",
"create_date": "2026-02-09T05:11:27.2978433+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-02-09T05:11:27.2978433+00:00"
},
"modified_dateutc": "2026-02-09T05:11:27.2978433+00:00",
"id2": 22
}