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": "73d1aefe-deae-47f2-a758-51b4f12b490e",
"_parent_id": "13ff70f4-b53a-4ebb-aaff-92c44227c15f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "91e8fab4-cfa7-4b1c-b575-271f0a2df945",
"company_id": "a389fbde-9906-4356-b311-61f0b8e2b678",
"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": "80814ba7-fb20-4eef-84ad-ca92abd7d9a9",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "cee6e118-f26d-4991-99d7-57001fea4858",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "25179611-1373-4e6b-8b17-4caab32515fb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4aaf22ce-b430-45ab-b1b2-fcbea62563f8",
"company_code": "sample string 5",
"company": {
"id": "bd299c10-11e3-4329-9755-e8223392fdf4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-09T03:20:21.779796+00:00",
"sales_territory_id": "0ea186cb-8b9d-46b7-b547-c2f278fe15b3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e1beff0d-804f-41cf-8f7c-4db3f9d41147",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c2bc241e-659b-4172-b9e9-62cc96fa8dc6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5419cfcf-9575-4892-a250-8d5692f07778",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4f6142b-2a32-4b32-9f32-3d0b134ad1ba",
"db_currency_id": "718d160b-dab6-4e2e-9f50-021c260f95f2",
"db_language_id": "8caf8392-a8d7-4ded-9b98-0e693ec3d75c",
"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-04-09T03:20:21.779796+00:00"
},
"modified_dateutc": "2026-04-09T03:20:21.779796+00:00"
},
"marketing_segment_id": "5933ee55-7dca-4dc6-8e3e-bc86c6e4e066",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "14fedc87-d064-4aa0-84b7-f74cb1231798",
"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": "c61abb94-3d19-4fc0-9138-140b3100070b",
"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": "4284aa89-f11d-421a-8e15-82797ef69200",
"db_country_code": "sample string 28",
"feelist_id": "609e3afa-8f8f-4f4b-993b-de78d003b541",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ca72e0be-afd8-4eea-8634-45e559df0277",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "22444422-8781-4448-b1ef-b548001b785d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-09T03:20:21.779796+00:00",
"db_currency_id": "4dfb5783-196f-4f1f-89b3-b81f7f264631",
"db_currency_code": "sample string 10"
},
"company_type_id": "a4cbc3cb-8ffa-4f64-a0b0-b12de9d2795e",
"company_type_name": "sample string 32",
"company_type": {
"id": "4b83aeae-788f-4244-94b9-affb5549f4ff",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c933b672-cfb3-432d-b0f2-ee2434b62c6a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "df8268e3-cec1-47b9-92fc-f1fc49405e29",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7f91b77c-5cd8-4ebc-b125-6db3e5dd08c7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e97366b8-ba9c-4afe-87a1-a82d0340e21d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0313321e-8850-469e-ab51-37a8205cfd41",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-09T03:20:21.779796+00:00"
},
"company_sector_id": "c3289499-4f19-4daa-b494-969053996347",
"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": "76dc3e67-93d7-45de-a319-a3dc8bcd981f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7921ec76-b669-4b04-9aa6-ccbfacd98472",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1cb2056c-3d6c-4c40-b0e5-86b234606e98",
"account_manager_user_code": "sample string 56",
"company_status_id": "099d9ac9-30ef-4dc6-83d3-e2b87d1aa11f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-09T03:20:21.779796+00:00",
"id2": 60
},
"db_language_id": "5108ecea-bd70-4411-9551-97e892dd4ff6",
"db_language_code": "sample string 7",
"db_title_id": "1704263e-3883-47d2-9429-bbc5b0793a33",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-09T03:20:21.779796+00:00",
"create_date": "2026-04-09T03:20:21.779796+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-04-09T03:20:21.779796+00:00"
},
"modified_dateutc": "2026-04-09T03:20:21.779796+00:00",
"id2": 22
}