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": "74236444-b0bf-4756-a6b2-bc62ceee275d",
"_parent_id": "8edab966-3841-4f3d-9dda-cb3c4cdb8a5a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "fdd7d472-3d59-4f09-be6b-4b6a66bb421a",
"company_id": "4e824e81-9f64-4e73-907d-808edc4e9310",
"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": "2a75f03f-7feb-4efd-abfb-3cfd75d4c7a5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c7c52ae9-4fa9-415e-8166-512b838dc3a8",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "5eac90d3-3287-4839-8e59-a1642da6ed5b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "60c40efb-3c88-4d0e-b5a0-25a42ffd0c0d",
"company_code": "sample string 5",
"company": {
"id": "e396cc04-e8c7-4bce-9be9-82799c4f1a31",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-19T04:41:26.0088006+00:00",
"sales_territory_id": "1f5c2c6e-9525-4982-af8e-a42ae2f4e85a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e5141055-418f-47b3-8131-4f4e3cdc0552",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "39806507-c309-4f30-81b8-e3fbfa889360",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3f818468-9181-420b-a824-d53cc3a42927",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c3c7f264-fd6a-4f1a-a4eb-2e3a9163b30c",
"db_currency_id": "75260645-9ffa-4acf-88bf-fcd06f5b5bc8",
"db_language_id": "d41ca831-3437-436a-8a8d-3a0f0720a95f",
"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-09-19T04:41:26.0088006+00:00"
},
"modified_dateutc": "2025-09-19T04:41:26.0088006+00:00"
},
"marketing_segment_id": "387bee3c-fe64-4c01-8e8f-33011f8b2eb2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6050742b-1567-4956-8e33-1a2ee472ca77",
"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": "40f3309d-aafd-42fe-88e9-810feacdcc7f",
"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": "dafa667e-62a7-4278-ae4c-b21d0059acb8",
"db_country_code": "sample string 28",
"feelist_id": "b83af408-dcf2-4f7a-a40a-0bf48287cd92",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "007e55d9-e93c-441c-b014-65026ff4076c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "90aa0033-6660-43be-a379-f5a90f8dc5ce",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-19T04:41:26.0088006+00:00",
"db_currency_id": "7a456972-c260-4bad-b600-6dcaad8375ac",
"db_currency_code": "sample string 10"
},
"company_type_id": "430c7fb0-31d2-4da1-93f7-8bb34b29694e",
"company_type_name": "sample string 32",
"company_type": {
"id": "42de4562-1669-48fe-9655-276004a6ce25",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f5e1451b-c2db-4192-bb70-3044a2c87dd1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f428b0f1-2a94-41e2-858f-20f679f596b7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "54f65457-e73d-4aa2-893a-0413c1b4d07a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "21cb6cbc-9007-43bb-88fe-0bf931e10021",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "083bba5b-d66d-4000-8409-c087744fa8a9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-19T04:41:26.0088006+00:00"
},
"company_sector_id": "a16298c4-91fe-4756-89aa-cdc5c63bcc86",
"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": "9e47c494-bce6-4b6a-8490-7df0760124ef",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "72202b05-f8ea-4d9a-8603-e53d2cd007a5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "54d56f59-9838-4fa2-8a88-24635ada30b0",
"account_manager_user_code": "sample string 56",
"company_status_id": "9643db38-3aa5-4b50-bfb7-6adb882e7afc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-19T04:41:26.0088006+00:00",
"id2": 60
},
"db_language_id": "888d02a5-acfd-4430-aee2-96ce6c2b714b",
"db_language_code": "sample string 7",
"db_title_id": "c4d3521e-6a86-468e-9363-a4bfa4cbbf60",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-19T04:41:26.0088006+00:00",
"create_date": "2025-09-19T04:41:26.0088006+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-09-19T04:41:26.0244297+00:00"
},
"modified_dateutc": "2025-09-19T04:41:26.0244297+00:00",
"id2": 22
}