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": "0aaf0a7b-6d32-4a26-93e7-ac5b0c61862e",
"_parent_id": "8bd463a3-88fa-475b-832b-779cb32b1d95",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f07376f5-6384-4c94-80e0-b64a23b10008",
"company_id": "3e6ced18-0dc0-4d6b-982f-81a5399f4c2d",
"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": "c41d8f5f-336f-49e0-8f5f-a5f21b6c9b37",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "1350e1fa-7b0b-4422-a71d-76e76725e132",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "5a17085e-50f4-4163-ad23-3a48bb76dc7a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2c86a284-984a-4915-bacb-a71ab53e8bff",
"company_code": "sample string 5",
"company": {
"id": "20fb4ad6-7fa8-40f6-a64b-44ee07ef0e00",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-11T23:43:53.9825655+00:00",
"sales_territory_id": "9ac38ac1-d6a6-43ba-8d23-6137e99cb190",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1e3cc52e-07d3-4640-8820-503f9ac403b3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4ed9889b-7089-4bdf-8da5-819d5919329b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "df6a918b-e3e0-4afe-b4bf-91e26ac6e595",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e41deecf-dfd3-4a3b-8c5c-f7114bfa5013",
"db_currency_id": "e275a167-3df3-47f0-89a5-41364c3d4c99",
"db_language_id": "05e97e3f-ff37-4440-9743-29746cf591d4",
"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-07-11T23:43:53.9825655+00:00"
},
"modified_dateutc": "2025-07-11T23:43:53.9825655+00:00"
},
"marketing_segment_id": "23807a85-f013-4f64-b2a0-fcc2fd9e4969",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "968298c6-57d6-4c5b-9dd2-e3ed4885d31d",
"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": "fb95af49-220a-4f75-8934-b62cb91479ec",
"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": "56081140-0dc2-43f1-a600-b87ffe79c793",
"db_country_code": "sample string 28",
"feelist_id": "195827fb-7b84-480f-b21e-486c87b8aec2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "332fe6a0-ede5-4bf7-a66e-575c97dbd299",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1d547a2e-e972-43ae-a86b-e46a5df1401f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-11T23:43:53.9825655+00:00",
"db_currency_id": "d9e6cd3a-2126-4909-b602-11f1d71406da",
"db_currency_code": "sample string 10"
},
"company_type_id": "9f701454-57b5-40cb-9576-fa4d8d7046d9",
"company_type_name": "sample string 32",
"company_type": {
"id": "5535b2de-df2c-42d2-af1d-1ac95f500d8e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "931f0a55-1501-4107-a140-d51a4a59a3e2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e299c1e8-dafd-4003-9a31-fe1dca5173b3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d1b656f0-483a-4bbf-add2-6c32eba0d92b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "79d723fe-cfa2-4c4f-9248-f55cc9aaf613",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "809b1788-a3ec-4cf7-bc0c-8a5bf89dff77",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-11T23:43:53.9825655+00:00"
},
"company_sector_id": "fc8f7a95-129c-4d66-9378-3b76ba7d4845",
"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": "d80ac49a-d352-4e27-aeaf-9da47386be77",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0027a330-95b3-4bc3-9f7b-c5ee7f19fa44",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8b3814e7-7607-4282-9a08-1d312fe09b42",
"account_manager_user_code": "sample string 56",
"company_status_id": "0c3d8fb7-27da-49f8-b67e-9e46d205907d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-11T23:43:53.9825655+00:00",
"id2": 60
},
"db_language_id": "37854e84-05c3-4f05-86d4-eefaa9954834",
"db_language_code": "sample string 7",
"db_title_id": "c113f1ee-e46e-4c49-94c3-0cb06a4f54ba",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-11T23:43:53.9825655+00:00",
"create_date": "2025-07-11T23:43:53.9825655+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-07-11T23:43:53.9825655+00:00"
},
"modified_dateutc": "2025-07-11T23:43:53.9825655+00:00",
"id2": 22
}