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": "94918705-8f7d-44db-bd94-aa071b2a91c2",
"_parent_id": "139ed247-70e7-4995-89b5-3ead666563ba",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "780f0650-d309-4e61-a07e-210c042214b2",
"company_id": "0fad2022-11ab-4d08-a4d3-42973faaf79e",
"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": "d6b1fdc0-9655-4b40-8e24-e3812b758d88",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "bf2b03cf-4365-4b2a-812d-9bc888684c20",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ed27c6c1-f715-4df7-ac26-484a46f0dcdc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e2534a72-c13a-4533-99d7-3952f81b2f1a",
"company_code": "sample string 5",
"company": {
"id": "61f870df-4d2a-4a83-ad7a-2caf546ed72e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-23T00:12:58.2884194+00:00",
"sales_territory_id": "57bc02e8-8a07-4b6d-bc3c-0b7be65d560b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "76ba4671-0879-4698-9da8-6c15cdd39d16",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f334d37c-a7c6-41a8-8806-11cdfb117149",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4507d3d1-ea4d-4f41-9928-10b43f36787e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f3a20db-3fc8-4f51-be4d-0f1f71d89f13",
"db_currency_id": "322c8f69-3676-4987-8431-7c9d837e3eb8",
"db_language_id": "ca867cc1-b553-465c-97ec-28813c51d69c",
"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-10-23T00:12:58.2884194+00:00"
},
"modified_dateutc": "2026-10-23T00:12:58.2884194+00:00"
},
"marketing_segment_id": "d7090e41-5791-4b40-9f87-3e87f72c68cd",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9f6acfd7-e664-4e21-a4ab-c524fec4d2c7",
"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": "498245ee-72d7-4cdf-9939-df979b4511fb",
"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": "0db36c02-5df1-49cc-ae45-ec2983dd938a",
"db_country_code": "sample string 28",
"feelist_id": "bd3ad923-21c4-46b5-980e-3e531f7f90af",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ba3ef83b-fdff-43fd-9400-06aeb60f6a7d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "94e6a7f6-7808-460c-af62-23513292068d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-23T00:12:58.2884194+00:00",
"db_currency_id": "db19b755-0d8b-4334-8742-8bdf75baae5a",
"db_currency_code": "sample string 10"
},
"company_type_id": "c5930e72-87c2-463f-ad45-7d217f1cfb67",
"company_type_name": "sample string 32",
"company_type": {
"id": "571e95ab-f384-48c3-a175-a96215657a46",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6a9066d2-e1f0-4a0d-a5fa-d1369c798744",
"sales_organization_code": "sample string 5"
},
"db_language_id": "63005638-1822-4ab1-8729-f741f31c3f1f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3891e610-af16-42cd-a021-4d696be2f1cb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cc0e8108-8c13-4b3a-9623-316e1a41e401",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8cec6b43-b7ac-4e2a-a7b7-cbd46df16df8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-23T00:12:58.2884194+00:00"
},
"company_sector_id": "cffb99ff-f44a-4234-a017-0eade19262da",
"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": "bbc7e568-4d03-4dc9-acee-5d9e1b9f0127",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5e9520a7-df2e-4a10-98f7-9fef663304a0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a1f65013-7d68-47d3-81dc-b3cc3b924e9d",
"account_manager_user_code": "sample string 56",
"company_status_id": "e1d4d4d9-02cf-4d00-86a6-7f7fe2a71a0f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-23T00:12:58.2884194+00:00",
"id2": 60
},
"db_language_id": "3641db83-82dc-4513-9e19-d53a90da1440",
"db_language_code": "sample string 7",
"db_title_id": "a3ca19c3-decc-4e3e-b386-0586ea61b0e4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-23T00:12:58.2884194+00:00",
"create_date": "2026-10-23T00:12:58.2884194+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-10-23T00:12:58.2884194+00:00"
},
"modified_dateutc": "2026-10-23T00:12:58.2884194+00:00",
"id2": 22
}