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": "2d777c73-1141-41db-a8ff-219ebff3f84e",
"_parent_id": "0dac7f92-7c5f-4de9-aa9d-9b60e9061197",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "658645dc-e067-45ad-929f-879a906834d4",
"company_id": "86ba52b5-68fa-4570-9785-26f7733991cd",
"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": "461e2381-12d5-442d-bb65-710a7b9fa897",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "00064370-39a7-41d0-8db8-2b19eb53b72b",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "8b042500-3a0c-4b34-8479-94b123b1e98e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8beac21e-4b98-452d-ac0a-3ee2ab1b6b8d",
"company_code": "sample string 5",
"company": {
"id": "1f139838-6f3e-4ba3-b19c-c017df70a481",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-19T22:52:26.1396473+00:00",
"sales_territory_id": "da972aa6-41fe-48ba-a8c9-b302b99a3724",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2758c695-ca5c-4425-844f-516f68bdffc7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f62b96b6-1029-44f6-bbb3-c113b7f18870",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "25c454f7-1eb3-4aee-924e-90126dd2af3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41add109-3103-40b1-81e4-d3fe6a7d5a68",
"db_currency_id": "a763ea45-bf6d-4f1c-83ef-bdd7d2e72748",
"db_language_id": "1c5a3255-5f72-4606-9930-a81d6be73057",
"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-08-19T22:52:26.1396473+00:00"
},
"modified_dateutc": "2026-08-19T22:52:26.1396473+00:00"
},
"marketing_segment_id": "80306201-a456-4064-b44e-3a2c3f6ea5a2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1f0904ae-7e98-4338-b28b-12a56ce5dd59",
"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": "4e088b8d-dbc7-465d-a484-8b809856afec",
"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": "7d672116-ab2e-4342-ac32-371dcdce0c0b",
"db_country_code": "sample string 28",
"feelist_id": "8d2db0c0-f702-484b-804b-cb5ef7a64dae",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "df203f87-9dcc-44aa-9738-933db04d0577",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f7b45939-4298-462b-be42-6cda52f462fb",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-19T22:52:26.1396473+00:00",
"db_currency_id": "b20b5132-bc15-4d93-a2cb-896c62e7adc8",
"db_currency_code": "sample string 10"
},
"company_type_id": "17cf76bf-07a3-4941-8c53-3196a43372ef",
"company_type_name": "sample string 32",
"company_type": {
"id": "23a03ce3-f8b1-43aa-9de9-fc6719e806ca",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8b069ddd-00e4-49b3-a8b4-bea757197df0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d8b00113-6d1b-4f48-910a-c7c0c64de6d1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "445bdd20-2ecf-40d9-9e81-92a8ffbb0eec",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "39ea37bc-5d36-46f1-8690-3472374ccc52",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1037b877-8c5d-424d-a8cc-b401e2bd5c06",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-19T22:52:26.1396473+00:00"
},
"company_sector_id": "45a515bd-ee4f-41ab-b7ab-d69c4159f92f",
"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": "bc6dcb8a-c477-44eb-a967-e9996894c99c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3adb70c4-6c55-4e25-9e8c-29a17e20a7b5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e2df5ba9-5eb5-4d41-8ec2-b985de160513",
"account_manager_user_code": "sample string 56",
"company_status_id": "70e01c4f-ca0a-49df-9a2b-2006901afd1d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-19T22:52:26.1396473+00:00",
"id2": 60
},
"db_language_id": "9d50533e-21e7-48b6-b6c7-ecbe7a2a724b",
"db_language_code": "sample string 7",
"db_title_id": "5b445e7f-87fa-4880-9117-870e34ad920c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-19T22:52:26.1396473+00:00",
"create_date": "2026-08-19T22:52:26.1396473+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-08-19T22:52:26.1396473+00:00"
},
"modified_dateutc": "2026-08-19T22:52:26.1396473+00:00",
"id2": 22
}