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": "7bbc06ff-57ad-4f5e-8943-b7f6a46a3ce9",
"_parent_id": "05012aaa-c7f3-40f1-951b-b14963fd2bdf",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "12c4e312-17df-44c1-a2e3-bb415607c16b",
"company_id": "e56d8ef0-4c72-4b7c-ad22-df25b7fdcc60",
"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": "8064c4c7-b541-4a70-ab1f-250c721b198c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "9c02813a-c707-4bf6-85b1-ddb9b70db8e9",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a8a260b0-3c86-4fa6-9e8e-16ed8cc4af90",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "eace8888-1d18-479c-86a5-1a6c128c32a9",
"company_code": "sample string 5",
"company": {
"id": "c3febfa7-0926-4829-a1a9-5a6279f8ff6d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-28T01:18:32.2614704+00:00",
"sales_territory_id": "4f9c37da-ca04-408a-bba3-4f65b80077b8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3c864e2b-f870-4a31-9d11-279a9a3d93d8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b7801c6d-8895-4343-a37b-881ba8266ef4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4f8b572e-d089-4a2f-a26c-ca255b177d8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10e1af2b-0607-43e6-ba5f-22c9bf75ec6c",
"db_currency_id": "45a37eca-8902-4a9b-a850-1ca2fe5ad178",
"db_language_id": "a1ddd9e0-3ecf-4bd9-8cce-1194e79d00b8",
"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-01-28T01:18:32.2614704+00:00"
},
"modified_dateutc": "2026-01-28T01:18:32.2614704+00:00"
},
"marketing_segment_id": "c67a4ec7-51b4-442b-b29d-fc15bc12d63b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5740f8e3-9653-434a-b616-2279a72ea090",
"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": "e45f794e-b5b1-4812-b841-e8ffa1c8d289",
"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": "ed6340f8-6f97-49d7-a836-d4b2991ce896",
"db_country_code": "sample string 28",
"feelist_id": "41078721-df54-44c0-9355-0c72fed7d917",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c3e34fda-daaf-490b-8bab-e06c8d0ba2cf",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f7d393a3-9ff1-432c-9021-8fbd3ed1976e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-28T01:18:32.2614704+00:00",
"db_currency_id": "718b3712-8038-4dc1-8e68-18104ab4d3e0",
"db_currency_code": "sample string 10"
},
"company_type_id": "90d805aa-a4f9-4943-b842-59d274b4a4ef",
"company_type_name": "sample string 32",
"company_type": {
"id": "77c38ac6-901e-423e-8f88-8590965dbf81",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "98701f51-acd4-4161-b53c-0ea850567794",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c757ed28-c6e3-4244-bc28-a5435908f14a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b8901e70-3233-4ab0-88d1-0298408f827b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1dcba71c-fe6c-441a-9cfa-44b2c043638e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b84deb24-4e9d-4e83-933a-305a12319ca4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-28T01:18:32.2614704+00:00"
},
"company_sector_id": "dd3d70b1-364b-47d8-82cd-b82d0f85c804",
"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": "ba829119-99dc-4ca6-a396-7e780fd2f269",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ad586ff7-3874-48d4-856b-cb2d01c4355c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "da3057d5-e09e-4f30-86e1-c584673582fd",
"account_manager_user_code": "sample string 56",
"company_status_id": "ab40299b-e7f2-4f0b-a004-d46addd177f1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-28T01:18:32.2614704+00:00",
"id2": 60
},
"db_language_id": "a23cbeb8-07e5-4e49-a8c9-398863556eb9",
"db_language_code": "sample string 7",
"db_title_id": "6eb5969f-1a4a-4caf-9f33-a8124b8c38ef",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-28T01:18:32.2614704+00:00",
"create_date": "2026-01-28T01:18:32.2614704+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-01-28T01:18:32.2614704+00:00"
},
"modified_dateutc": "2026-01-28T01:18:32.2614704+00:00",
"id2": 22
}