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": "cbc74c4c-9658-4844-b13d-0058af8713fb",
"_parent_id": "5bd1be02-eb02-45eb-a944-aa1da1f486fd",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "d50438bc-4158-4e7c-8be0-7f90cb483a6f",
"company_id": "8d77fcf1-d368-483f-a2df-577f4ce3f239",
"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": "6de2da9c-6358-4c3c-9922-ec4085fe332c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "cbc58792-04ea-4306-9934-1c8604d40857",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "80bf2540-34a0-4c49-81c6-f35ae7e6ddc0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7a565604-7560-4ba7-a2c8-5b7e7d37855b",
"company_code": "sample string 5",
"company": {
"id": "caccdb2a-09c1-4426-9613-e2a869ac9763",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-16T17:54:44.71378+00:00",
"sales_territory_id": "8b70c6a7-4520-41ee-b248-7ce393bb1ac9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f4e7f5d7-5fd9-4539-b26e-dd22b05a9b10",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "65071c45-e095-43e8-8471-8e480f2a9d9f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f0716c5d-54be-482a-a68c-fcbadc2046b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b9fb148-2cc4-4b1c-8c5b-a986f80c1e47",
"db_currency_id": "84fd3c78-38d4-48cc-9476-aa2b287e34cc",
"db_language_id": "6eb2d0f5-34d3-42c4-98aa-a67836c5c52e",
"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": "2025-12-16T17:54:44.71378+00:00"
},
"modified_dateutc": "2025-12-16T17:54:44.71378+00:00"
},
"marketing_segment_id": "d1dbe0b9-0ef1-4273-a2bb-42a7a170eec6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b944ec95-ef0a-4212-bc2b-48702d4d5ee1",
"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": "19920bc4-d688-478d-9894-996e0ef1185e",
"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": "d2bc0b3d-f358-4986-bac2-7653a192b8ac",
"db_country_code": "sample string 28",
"feelist_id": "e9f51c73-6d77-4e70-8112-e06a5681b8a2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9852cbd9-b02b-40e8-9286-6749a407d0d5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c80e0af1-d7b3-4e2f-bacc-24a0c6ddd37d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-16T17:54:44.71378+00:00",
"db_currency_id": "17cbc9e3-25d9-4210-bc69-4f8498101b0b",
"db_currency_code": "sample string 10"
},
"company_type_id": "83025695-a405-4012-ac4a-ada092e18b17",
"company_type_name": "sample string 32",
"company_type": {
"id": "fd26dba2-6d2e-4013-82ba-216a843592d6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "323a6b0b-cb14-479a-8095-d3ec8f190f27",
"sales_organization_code": "sample string 5"
},
"db_language_id": "08febb53-ab05-469a-98d5-d86a210c9122",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cbac42c8-db80-4ff7-ac18-41826e05b1fa",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "82f0339f-d49d-4337-b4e7-1a77eaf65f01",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "65e2f3ef-b0e0-4614-a535-644e62693b4f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-16T17:54:44.71378+00:00"
},
"company_sector_id": "0b89672f-07ae-43cf-87cc-f7b969bacbee",
"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": "32b45ef2-0bd1-4089-86d4-4496913d3845",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2faad9dc-46d7-4173-b288-086c6df3084f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "983de4ba-5afc-40a6-b2bb-de2dc2c1cb74",
"account_manager_user_code": "sample string 56",
"company_status_id": "9ea0509d-d66a-4d2f-8682-b7283e7c1b82",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-16T17:54:44.71378+00:00",
"id2": 60
},
"db_language_id": "3b51f59f-2811-4e7f-8b20-bff55297adf9",
"db_language_code": "sample string 7",
"db_title_id": "212740d4-df2a-4b5d-bcc6-aee9d4597c2d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-16T17:54:44.71378+00:00",
"create_date": "2025-12-16T17:54:44.71378+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": "2025-12-16T17:54:44.71378+00:00"
},
"modified_dateutc": "2025-12-16T17:54:44.71378+00:00",
"id2": 22
}