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": "0bb164ab-b694-44d7-b22f-1c5228c40d65",
"_parent_id": "2f06a526-af80-4618-b2d9-3ed6cb6cd36a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "d2bad4a9-461a-4f13-8777-9e6d79efaf73",
"company_id": "20b7d33f-109e-468a-bcd9-19c23a483444",
"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": "f8a09170-9ce1-4353-9e42-6333d7036136",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "7e410354-8982-46f5-ae13-3e5181150019",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3b254e82-a1d4-4f23-9548-b18a010f0aa5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6b1b1674-2343-4964-bb36-35cb5f87e3d8",
"company_code": "sample string 5",
"company": {
"id": "ffd39a70-27ee-423f-843a-22133ce01418",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-16T18:02:40.3653312+00:00",
"sales_territory_id": "808a7bde-d957-4ecd-9c4c-5a3a4549b8a9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "07b69aa0-2c2a-474c-8d6e-1d57c80afadc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e36e37bb-242a-4133-bc15-90fafa524f08",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7b1b03a5-5c92-453f-b18f-c042b622b335",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41162b4c-2254-493e-baa7-252f8f225305",
"db_currency_id": "0cb3b70c-bcdf-4682-8948-faf64bfa2365",
"db_language_id": "70cd54a0-40e1-4c01-b1c0-732ae9a2fa93",
"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-16T18:02:40.3653312+00:00"
},
"modified_dateutc": "2026-02-16T18:02:40.3653312+00:00"
},
"marketing_segment_id": "fe7f2aa4-144c-43ad-a0ae-2b5bcec660ea",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b17aa090-faa7-4c26-8e28-1937243602ad",
"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": "becea279-9c6d-464a-a2c3-522fafcad9a5",
"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": "542c2660-5b24-4323-9ce9-34ea7b5d7f36",
"db_country_code": "sample string 28",
"feelist_id": "b6c8d3ce-78d9-438e-a31e-09ac27293f95",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3baef63a-7481-4f8b-99bd-11b05938bb27",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4c6bb610-92b5-4c11-a998-1ae8965775e4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-16T18:02:40.3653312+00:00",
"db_currency_id": "aba4a3b0-6ea3-41c1-9517-63fc07887edd",
"db_currency_code": "sample string 10"
},
"company_type_id": "cd9c5ccc-037b-4238-aaf5-9454d2ed41b7",
"company_type_name": "sample string 32",
"company_type": {
"id": "8ea88e34-49ba-4c83-9a70-a672a9e650d4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9efbc93d-50ca-46fe-8de4-a60aec01d104",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4c412663-5bba-449e-911b-ade0ece5ebd7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "922333aa-f9f0-4cbc-bc37-e8ea4b0d5033",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cdebb0a3-9b15-4539-84d0-cce5fa77e270",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d3eb73c9-8d2a-40ea-a41b-623c9239c04c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-16T18:02:40.3653312+00:00"
},
"company_sector_id": "edb19b74-0c78-48ab-9fb6-c66031bab9aa",
"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": "1fb6c02b-af55-4b61-a9a2-33e72073ac84",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "88c00d25-46e9-4584-9799-274d7e794ae5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "47afb2ba-626e-47e3-9bf0-6ea7214ed0b0",
"account_manager_user_code": "sample string 56",
"company_status_id": "5e90569b-f7d7-43d1-b798-b8aa9533f5fc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-16T18:02:40.3653312+00:00",
"id2": 60
},
"db_language_id": "07ce0de9-6ae7-4e91-92fc-ec11a23626c4",
"db_language_code": "sample string 7",
"db_title_id": "95605af7-496e-4eec-a905-033572a67dd7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-16T18:02:40.3653312+00:00",
"create_date": "2026-02-16T18:02:40.3653312+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-16T18:02:40.3653312+00:00"
},
"modified_dateutc": "2026-02-16T18:02:40.3653312+00:00",
"id2": 22
}