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": "1024d52d-f33d-4033-a7e6-1267a6168236",
"_parent_id": "d618fa19-9724-41c9-a124-5fe3b11be2a7",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "143fb395-6528-4740-b632-e33341f122ae",
"company_id": "ea129fb9-b525-4795-9c07-bbba53df5369",
"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": "63f551ab-16f1-4d3d-bc48-8c568313fb88",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c989f9df-9025-4867-b5ec-d2849dbcf327",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "644e4ca5-a4e0-44f3-b357-2bc6060d5d12",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1599b625-465e-4847-8d4a-85d14156bfa5",
"company_code": "sample string 5",
"company": {
"id": "9b66a7b7-ccd8-4abe-9bd8-6fdf6b15bc7f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-11T23:08:37.9480536+00:00",
"sales_territory_id": "51e012ea-ed95-48ff-91ba-c38cbc8d7ee4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c3836584-1cf4-4895-aa92-c3a1850a8a2c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5916dc9a-4f51-4e43-b12c-09510c550914",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ae662442-d8de-422e-99cc-0247f134be41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c082a78-8716-40b4-9fb0-09573d6b7423",
"db_currency_id": "7fa503eb-d89d-4680-946b-182b77a37ba8",
"db_language_id": "7ebfd425-6ffc-4d05-bde5-1b383a5e05b7",
"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-11T23:08:37.9480536+00:00"
},
"modified_dateutc": "2026-07-11T23:08:37.9480536+00:00"
},
"marketing_segment_id": "6ae8382f-6fd0-4309-92c9-4a327604ede9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e5c5f2df-aa97-463f-881a-d2b91593b9d9",
"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": "40b732db-54c1-455c-a8b8-94f5d6b1ee04",
"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": "df09f4bb-b7b0-4222-9831-8abe6af3cbd8",
"db_country_code": "sample string 28",
"feelist_id": "9d519347-42d1-4417-87c6-8fa1ffa56b60",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e0e03bc4-17c3-4b46-b08a-54f230bb2a8f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2206604c-926f-421e-8756-b8440ce30572",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-11T23:08:37.9480536+00:00",
"db_currency_id": "65508bb2-8815-49a2-b7ac-b8a3a2cda9fd",
"db_currency_code": "sample string 10"
},
"company_type_id": "afa66ec1-cbf8-48fe-873c-afb440f6b2f6",
"company_type_name": "sample string 32",
"company_type": {
"id": "1991a72c-22d6-4a4e-a97f-925365aa88b2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "65c83bdd-cabe-4951-bb8f-7a7c2af3f42e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5a005fad-b0ba-43b9-8faa-d7f7b47d9083",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8d17501a-bb99-45fa-966b-6863e1896f78",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2db13467-2884-4af1-8a0c-5919e397a9a5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d503f9b0-155c-4de8-b515-06eba15d194f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-11T23:08:37.9636781+00:00"
},
"company_sector_id": "46ce5001-a143-4678-9093-3a9d13b4a269",
"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": "fd0f3ecd-2e47-46f2-9b91-6c14d9dd5d5a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a3887831-89a4-4b35-b572-3072b46d711c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "163969bf-85e5-4f3f-961a-23f7ac311349",
"account_manager_user_code": "sample string 56",
"company_status_id": "178f97aa-8f13-421a-8dde-376d77c4d867",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-11T23:08:37.9636781+00:00",
"id2": 60
},
"db_language_id": "96616144-213f-415f-9d5e-20d8031dfa2c",
"db_language_code": "sample string 7",
"db_title_id": "f51546ec-8ab7-4ada-863e-69c098738747",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-11T23:08:37.9636781+00:00",
"create_date": "2026-07-11T23:08:37.9636781+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-11T23:08:37.9636781+00:00"
},
"modified_dateutc": "2026-07-11T23:08:37.9636781+00:00",
"id2": 22
}