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": "41780a6a-e527-43a0-b8f5-99e1ddcfd54c",
"_parent_id": "73ff46af-b004-4930-bc79-a87046bf0ca6",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "445b69be-fa10-4842-9e3d-ae89e0e8d5f5",
"company_id": "ddd30b72-d2e9-4ba8-b833-8fe01d1e6979",
"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": "891260f9-9e97-4201-be9d-4a040a6a7cca",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "aca76311-504c-4136-92e7-31019692a3dc",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "cf63b0c7-4bff-436f-951a-e4296127f30a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "450ad79a-fa5c-4fa8-9719-db4111e06180",
"company_code": "sample string 5",
"company": {
"id": "2aff323c-7844-42f9-97f8-10a0828a4e7c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-25T09:07:58.173557+00:00",
"sales_territory_id": "aefb448b-829a-46e3-b139-31720fb612f4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "94d157cc-1c7e-4355-be98-aa09c214d30e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1b83b2c9-efec-4e30-ab2e-4a16d0ca92c3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "36beef7d-3a2a-4f66-b577-d16fc0bd93bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "add1f99e-7ef2-4fd2-9388-ffc8cc5dd688",
"db_currency_id": "594756e1-0ed6-48a9-bda9-219fc405f14b",
"db_language_id": "8ebdd973-5592-4282-a7ad-18d015046bc6",
"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-25T09:07:58.173557+00:00"
},
"modified_dateutc": "2026-02-25T09:07:58.173557+00:00"
},
"marketing_segment_id": "f370626c-d2d7-4c88-8816-1668e149055c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "04d0efa6-f227-42ff-9ef8-e6c1b47c77f0",
"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": "084f958f-43f1-403c-b69a-654bd752bb9e",
"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": "8c174ef2-a1f3-45ac-b043-c82bbe6922bc",
"db_country_code": "sample string 28",
"feelist_id": "588f08b8-ba9c-4376-82fb-3890a3759bde",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "013cd727-9601-452c-a00b-4261d7e2ead2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b3d6d9cb-e255-43bf-8e5e-b1db700030e4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-25T09:07:58.173557+00:00",
"db_currency_id": "4c0162bc-3cf0-4d32-b944-c2e96b117bb1",
"db_currency_code": "sample string 10"
},
"company_type_id": "c8d98b50-603c-4755-9bf6-659342128546",
"company_type_name": "sample string 32",
"company_type": {
"id": "2419365a-f218-4355-ad1e-f455958b00ee",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "60898a70-cc23-48a9-a83d-9c2c4480d915",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d3e93a66-7c84-4a8c-bff2-1ab8d26191be",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1e936582-c120-4c5f-ada7-58cfd1d17a41",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "376181d0-c696-45af-ab10-509ae0c91cf8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "38537845-4df3-44c7-ac7b-a20d6456545b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-25T09:07:58.173557+00:00"
},
"company_sector_id": "f60b09bd-67e2-4710-89d0-d6331e938a2e",
"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": "8cc2d39f-e6dc-4461-8ee5-aa7a5d42a678",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bafe9f5a-b27e-4615-9050-ec10b71bdfe4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2da04e20-f31d-419b-b659-879b5c50a382",
"account_manager_user_code": "sample string 56",
"company_status_id": "bed6036a-225f-48e5-87b8-e2a02b2e7559",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-25T09:07:58.173557+00:00",
"id2": 60
},
"db_language_id": "457f3e4a-c82b-480b-9754-8337e894dceb",
"db_language_code": "sample string 7",
"db_title_id": "27da5cd7-e122-49a5-9740-d21f100c8666",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-25T09:07:58.173557+00:00",
"create_date": "2026-02-25T09:07:58.173557+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-25T09:07:58.173557+00:00"
},
"modified_dateutc": "2026-02-25T09:07:58.173557+00:00",
"id2": 22
}