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": "dbf149bc-0c87-4d9a-a41a-1957a681db33",
"_parent_id": "385ec7d2-9abc-4218-b55b-a7109bc384d3",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c9214a25-1484-4e8c-a63b-d0f68a9ddf17",
"company_id": "5b6b09de-e3ff-4567-902c-81b31219e682",
"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": "9bd6b105-7433-4405-a6d5-f4da978bfb2c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "80b17f84-bd43-48f8-8abf-3c3436504dcb",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c2e319ca-c2ae-4f37-b2f3-b52ee580cd98",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0ea9d8fd-97f9-4680-8b24-5798426a71a8",
"company_code": "sample string 5",
"company": {
"id": "c7a0d8db-a6de-438b-934d-924de2873a1b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-07T21:22:24.9209281+00:00",
"sales_territory_id": "968b7a33-4f00-46d6-aa92-7d478e8cb6ab",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "65c28ae5-3d34-43c0-99e8-32224171f35b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "73dc7594-3797-4497-9572-80eccf8006c0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e040fca6-ff07-47e6-9272-b53d567b98a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59d03288-7579-4a6d-8b39-3b5113624239",
"db_currency_id": "581bb470-a770-4c6c-86e6-7f792d3c4e4e",
"db_language_id": "ac655c05-a6da-4795-8ebe-64dd9f6d99e4",
"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-10-07T21:22:24.9209281+00:00"
},
"modified_dateutc": "2026-10-07T21:22:24.9209281+00:00"
},
"marketing_segment_id": "5135174c-5bab-4d50-adc4-6ed18e9a53dd",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0658c1a7-cf70-42c6-86fa-cfc32c51f8a4",
"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": "f53983b7-6d42-4655-8705-9c4efd5b61bd",
"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": "c3420188-b551-4e9f-85d2-036875411e85",
"db_country_code": "sample string 28",
"feelist_id": "529036a3-b16b-4bc6-b30d-46ea50689332",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "06bb8866-4e34-47a2-ba7a-71fc4ac3250e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a4d05295-fabd-4dfd-abab-eb88408f3cd9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-07T21:22:24.9209281+00:00",
"db_currency_id": "08c5c62f-eff6-4fb1-9f04-364c7a37552f",
"db_currency_code": "sample string 10"
},
"company_type_id": "596b450a-fe5a-465c-814c-aabab448f24a",
"company_type_name": "sample string 32",
"company_type": {
"id": "8c9b7f4d-b006-41cc-8ea9-e7006f88dcbe",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1aa63b27-9fdc-4cfb-91d7-6f178fb18092",
"sales_organization_code": "sample string 5"
},
"db_language_id": "75487efa-ecd9-4f8b-be45-aa64dda491fd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "60a77942-41b2-47a8-8cac-c73382c6a855",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ea8b9536-0dd1-4abd-96d7-aa7a5b71e997",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "cf5743d5-00c1-4b36-aaf4-53f2b907214c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-07T21:22:24.9209281+00:00"
},
"company_sector_id": "0d6b0cc1-35c8-4e1f-814e-0dd8cd356877",
"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": "8fa33742-dba9-45b6-882b-3e99c46f607e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6446a97e-ed2f-4375-bd6c-91052cb459d6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "38cd1656-de9b-4763-a9de-3aad02e3bf88",
"account_manager_user_code": "sample string 56",
"company_status_id": "e70b8298-c9d7-4d96-b320-780475784b1b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-07T21:22:24.9209281+00:00",
"id2": 60
},
"db_language_id": "a2a27153-e3b2-49d8-9f7e-d7cc4fd76bc2",
"db_language_code": "sample string 7",
"db_title_id": "b20ee6f8-4025-43c0-b57a-f11bd5ddc7ed",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-07T21:22:24.9209281+00:00",
"create_date": "2026-10-07T21:22:24.9209281+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-10-07T21:22:24.9209281+00:00"
},
"modified_dateutc": "2026-10-07T21:22:24.9209281+00:00",
"id2": 22
}