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": "129220e4-1a2a-4050-af64-bd1db77c7587",
"_parent_id": "b8dcf7f1-6af6-4399-a454-c879142bf9a0",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a77dbee2-0d6a-4ec3-9a82-be7643e7b7f5",
"company_id": "6c3f9fa4-3d4a-4537-809d-d618ee7d8746",
"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": "b54578c5-9ec5-481c-aa7b-bd40b3865749",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a5dc5b5b-337e-444d-b93c-8cb7099cc72d",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "09a7f281-8507-47d3-ac82-2a3e9558fa8a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c2810eed-7254-4999-aa5a-1fa336ca7a3f",
"company_code": "sample string 5",
"company": {
"id": "6259170d-8e35-422f-9038-c2b7203faab2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-26T00:48:58.1817271+00:00",
"sales_territory_id": "008ea880-ffb6-4547-b9d0-279965e73782",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5e237d1d-9cee-430a-b28f-d214052f4cd1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d2bd68e4-826e-457d-a586-01643a1b465c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a226440f-e281-4204-ada3-011ca92b9d5a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11a24c51-1da2-42d3-bc56-b8002b0b17a3",
"db_currency_id": "faaf6cec-d3c9-4d8a-9a03-57a309292297",
"db_language_id": "d18714f3-c647-48ab-a266-e1c2cf0c9e70",
"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-26T00:48:58.1817271+00:00"
},
"modified_dateutc": "2026-10-26T00:48:58.1817271+00:00"
},
"marketing_segment_id": "691ceaff-2e11-417c-8e7a-3ac6fdb76e49",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2d82fc82-29d4-4abb-8329-c4c1031e434c",
"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": "90344f19-7730-4e83-9676-8cf1ebc3869a",
"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": "b17c6baa-cd03-4272-b331-cd84c7c69b6d",
"db_country_code": "sample string 28",
"feelist_id": "2a653cd6-34d3-4a86-8f22-23a969f2cf8a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f22b8d50-4602-49b1-96b5-69bdd306aec8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ddd239d1-f9bb-4ed8-9312-8f4b37e62354",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-26T00:48:58.1817271+00:00",
"db_currency_id": "b513a322-6931-4cb0-ba00-2858198c403b",
"db_currency_code": "sample string 10"
},
"company_type_id": "39495aea-cd5a-48ba-b9f7-34b0fda31bfe",
"company_type_name": "sample string 32",
"company_type": {
"id": "83931fa8-4e91-439c-bff2-c56fc6a1c293",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "14ed2fb8-32c8-43a5-bcfe-34022020fe20",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e1859956-0a9a-4629-9da7-aa57fd9928d7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "650ea05a-0129-4a79-bc4b-995afb5ce1c3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cac0a48d-0a9d-47a5-a53e-5b25d53e8182",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8167a6a2-dd5d-4369-8e1b-a16c4effd29d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-26T00:48:58.1817271+00:00"
},
"company_sector_id": "b250721b-45ca-408c-b008-b37aef634cd4",
"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": "6cf3b250-e91c-4a84-8edb-fe1e46222918",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f62c4241-8bc6-492b-aaf9-0ea88d903ab8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e645f553-4439-48aa-94d6-60745930ec0d",
"account_manager_user_code": "sample string 56",
"company_status_id": "54990902-33e8-449e-be82-57808bf2b861",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-26T00:48:58.1817271+00:00",
"id2": 60
},
"db_language_id": "ee984f6f-cb96-4211-a0e8-a41694d2ead0",
"db_language_code": "sample string 7",
"db_title_id": "13fbf093-ad14-42c5-b0ac-e52cfeda031e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-26T00:48:58.1817271+00:00",
"create_date": "2026-10-26T00:48:58.1817271+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-26T00:48:58.1817271+00:00"
},
"modified_dateutc": "2026-10-26T00:48:58.1817271+00:00",
"id2": 22
}