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": "30897eaa-8216-413e-8761-9df8c55011f9",
"_parent_id": "164ad24c-9382-4b45-8b82-626813aea98c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "63b8e926-eff5-49f3-8d97-379f002900d3",
"company_id": "34c3a3ff-7e97-4764-8029-dec94d4c0e48",
"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": "0c3012d6-bfb9-412c-94ed-fce8ad915958",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "def5a3bd-a6a7-47d6-9140-eda9f6e58457",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "cf17b8e3-db76-415d-bdd0-7c2b0b2b8abd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d8c8ee75-27c9-4694-b7dc-a0c5d51f4f4d",
"company_code": "sample string 5",
"company": {
"id": "45a3f65f-c026-41d0-b190-b7b62d568163",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-11T05:52:24.8448662+00:00",
"sales_territory_id": "4c817ad6-2973-49ec-9d00-24670867985b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "186dabc4-71d7-4033-b45d-eb0f0d5ea661",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cfbe83b5-6767-4337-907b-b4b5c7954df0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dfcf1a3e-d34a-4b05-8e6d-c1218a5150eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "954f3b75-4c44-497a-9b23-8d9790bc9213",
"db_currency_id": "47b6b1f0-38a2-4e2d-9e66-11c391c7bb64",
"db_language_id": "e976b0da-3875-446e-a48d-fd732ea525cc",
"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-07-11T05:52:24.8448662+00:00"
},
"modified_dateutc": "2026-07-11T05:52:24.8448662+00:00"
},
"marketing_segment_id": "0af9b009-c795-4a23-823e-1fb8650a755d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a362b2db-e681-475a-88fa-fc4a178f8b7a",
"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": "e836e4a9-473f-4276-bf8f-e10a1292b288",
"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": "5253fb3d-3644-47f3-8d76-fb5a53b30086",
"db_country_code": "sample string 28",
"feelist_id": "9cbbfceb-08e3-4c44-b4ac-06be0c703035",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "efdbb507-a504-4fa8-9936-0072972b9960",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "50ebd004-ec82-4e4a-8272-be69f0bac172",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-11T05:52:24.8448662+00:00",
"db_currency_id": "693f8913-35d9-4f0e-bf3a-086fec1db097",
"db_currency_code": "sample string 10"
},
"company_type_id": "87179fb8-3bdc-4596-95ed-506834d61b74",
"company_type_name": "sample string 32",
"company_type": {
"id": "25c59190-7d7f-4a2a-b2c9-b4050022af7f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1dbb2615-5b5e-4a7c-9784-e3dcede99952",
"sales_organization_code": "sample string 5"
},
"db_language_id": "96fe1ffd-1e00-4fc2-bfe8-d4971748a11b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f0a6af5c-4d86-43c3-8321-dd5b492c9c0c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8d940b7a-5309-4ea2-a298-89d25f25ac60",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0e09dc96-704d-4342-9268-a1d78ba3efbf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-11T05:52:24.8448662+00:00"
},
"company_sector_id": "f3a8744b-1707-4e8a-be9f-7ff384526bbe",
"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": "949cf380-967d-489a-9aae-7c17f19ebbf0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d84d1022-141b-47fa-a69b-3473b6f987ba",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "20d5855f-0e7a-49bb-a2e2-faae06f1c24c",
"account_manager_user_code": "sample string 56",
"company_status_id": "e4f46c0b-ed94-4868-8077-bd17864743d2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-11T05:52:24.8448662+00:00",
"id2": 60
},
"db_language_id": "c03fdb3e-94de-4cef-808b-5dd34ffb49fd",
"db_language_code": "sample string 7",
"db_title_id": "c107ecc7-9349-4746-8756-9ed7b19876e5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-11T05:52:24.8448662+00:00",
"create_date": "2026-07-11T05:52:24.8448662+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-07-11T05:52:24.8448662+00:00"
},
"modified_dateutc": "2026-07-11T05:52:24.8448662+00:00",
"id2": 22
}