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": "dc7c63f8-db48-4b2f-879e-ea31088ba448",
"_parent_id": "24b1a97b-9d73-4a1d-b797-faccb04b1fcd",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1af30208-1886-432f-80a7-3133dba7e6b6",
"company_id": "4ec5e313-3996-4bf3-afb8-134c8d6c9dab",
"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": "e35daf83-3e60-40fa-94a1-1117afd67758",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c55bcea0-f1bb-4c24-9f8b-72b4637f3e41",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "fc22cb34-1132-4de8-8d20-53ea9e874fa6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c3f7eeba-4119-4541-8691-7376a1b09f13",
"company_code": "sample string 5",
"company": {
"id": "e0be8127-3f59-45cd-994e-58f84b74c647",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-27T16:39:28.8506515+00:00",
"sales_territory_id": "3284a648-8c46-4ef5-a6a0-69efc4a0fae3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7ca3e67d-bdaf-4175-9979-632facc82099",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "20037dea-4b91-4cca-baa0-17bc60a0bb92",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bd106c21-c61a-4cfe-8aae-284023e938f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f88f970e-3a1b-463d-aefd-045f36f5c18f",
"db_currency_id": "123afa01-985e-4c07-a023-8daef1b81d73",
"db_language_id": "d9f18b92-9432-4d8c-83b8-5f889ce52aaa",
"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-27T16:39:28.8506515+00:00"
},
"modified_dateutc": "2026-02-27T16:39:28.8506515+00:00"
},
"marketing_segment_id": "ffcc1712-af8e-40fb-a06c-b1a3fb620363",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a938a49e-a81a-4d97-8f0d-c38898f7e36a",
"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": "0376ca90-cfca-4573-9df6-47fa4be21ab1",
"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": "2eb810b1-b8f0-440c-9c62-7044a073f664",
"db_country_code": "sample string 28",
"feelist_id": "0da3bebe-c576-4312-b2d2-ecd32e12e090",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bf0cd7f7-4872-47a7-91f2-88d46ca645dc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5054ec6b-ce98-4711-bca4-6133f033ff54",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-27T16:39:28.8506515+00:00",
"db_currency_id": "bc4940d2-e46e-426e-bb48-4190860148b0",
"db_currency_code": "sample string 10"
},
"company_type_id": "7d8d75e8-41d7-4e19-98e6-211d206fdca5",
"company_type_name": "sample string 32",
"company_type": {
"id": "3149e255-2d1f-41cf-9dfa-50e3371a710e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7e4d8708-f224-492f-97e4-e7a11bd73cf6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "46603848-87d1-4d46-9a4f-307c94befd9a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5da9f222-48fc-49f6-87d8-5cee038d90e8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "99b49583-af69-4c84-9796-f2f799c58211",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ad5f765e-68ac-4311-8396-b6ca2019ff44",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-27T16:39:28.8506515+00:00"
},
"company_sector_id": "985b6b51-7a05-424a-8536-7dcb07042c53",
"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": "89ee76d2-f4a1-4552-b605-94c230bc59c2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "61759da5-17a3-4a39-af1e-92f07bde998b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "db787247-ab9d-4338-8a73-9db1d08d82c0",
"account_manager_user_code": "sample string 56",
"company_status_id": "c36487c5-ec09-4004-9806-0f68fdefa35b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-27T16:39:28.8506515+00:00",
"id2": 60
},
"db_language_id": "2fdfcffd-e86e-4f21-9025-e65156c90cae",
"db_language_code": "sample string 7",
"db_title_id": "b9d17b54-ba76-46c3-b67b-9fd542513bd0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-27T16:39:28.8506515+00:00",
"create_date": "2026-02-27T16:39:28.8506515+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-27T16:39:28.8506515+00:00"
},
"modified_dateutc": "2026-02-27T16:39:28.8506515+00:00",
"id2": 22
}