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": "e1db86b4-152c-454b-9072-16b020604ca8",
"_parent_id": "44021789-6856-4684-bad1-f92091102d47",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "7db4804e-d96e-4433-8601-aa5136ffe55e",
"company_id": "250733c3-7dcb-423c-b2ff-7cfc97bd20a2",
"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": "070aa703-4c96-4934-937b-12adf72172b3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0078c993-8107-4018-b3c7-32ee05923f18",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c733f921-ac60-48cf-afba-7792434a5f51",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7d0c8f6a-226a-42b7-a792-acaf37ef48b6",
"company_code": "sample string 5",
"company": {
"id": "710924eb-128a-4489-bc07-1838c9e54eaa",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-13T19:13:15.1103842+00:00",
"sales_territory_id": "e1b1f37c-6265-454d-aebd-4f8a4cd0ad7b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fce31a09-7246-4087-8cd0-1e3da68ec372",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4efcb1a5-75e0-4e25-a77f-797366420493",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bd8ada90-8366-40d9-baa2-fa999e19e739",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "642c3917-00a5-4a35-94ca-8f56e1d29221",
"db_currency_id": "d1ded8a8-7684-4b91-9059-f2690a7b3221",
"db_language_id": "5821fdb3-b50a-45b4-81cd-937d1a30c0c0",
"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-08-13T19:13:15.1103842+00:00"
},
"modified_dateutc": "2026-08-13T19:13:15.1103842+00:00"
},
"marketing_segment_id": "3f77e71c-3639-4380-96aa-bf045293db89",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f5e36d96-ce7c-4a94-8d25-27eb3546ed9f",
"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": "7d8c6c11-9388-4f47-8978-6140a3f3c5c6",
"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": "f0120bf0-a847-4a61-8c29-ac6d466f0a51",
"db_country_code": "sample string 28",
"feelist_id": "da89a30f-fba2-4354-96af-b7a6e070df2a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b846f603-d73d-47be-b9f4-60b08a94ab3b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8497704f-e88a-4bde-af02-1089563aec84",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-13T19:13:15.1103842+00:00",
"db_currency_id": "1be675de-3eac-4c1b-9a3c-49d007006221",
"db_currency_code": "sample string 10"
},
"company_type_id": "d8d3a7a0-9ba3-4968-bcd5-638f1cc1225e",
"company_type_name": "sample string 32",
"company_type": {
"id": "8fc5f1fe-7af9-4746-b259-0b413dcd44b3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "97282b3c-a485-45a4-add1-8c9b0d7c9b54",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3a5640b0-4dcf-4da3-94bb-c771a6a98228",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "63697d94-e8d1-44b0-a439-df63ef40240b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "824c6489-7107-4a97-b8cc-2fc58c369210",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5c872451-05cc-45d1-91da-9dc7f287e208",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-13T19:13:15.1103842+00:00"
},
"company_sector_id": "a35f37ef-b87b-4ea6-9ca0-477d038c8b26",
"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": "3ab686fa-ce2b-47c8-8678-5bae1a61eae4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2fc3c58d-cf6f-4b26-97cb-66cb0ed6233c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0654918c-a50e-4d2b-95e8-7fbf3ff38884",
"account_manager_user_code": "sample string 56",
"company_status_id": "7ebde660-76bc-4355-8b78-61a0b5d3bca7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-13T19:13:15.1103842+00:00",
"id2": 60
},
"db_language_id": "d26efe21-a00f-4281-a135-1178a918a7f3",
"db_language_code": "sample string 7",
"db_title_id": "9635d986-99f4-45de-b045-f07297153f19",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-13T19:13:15.1103842+00:00",
"create_date": "2026-08-13T19:13:15.1103842+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-08-13T19:13:15.1103842+00:00"
},
"modified_dateutc": "2026-08-13T19:13:15.1103842+00:00",
"id2": 22
}