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": "fdc7f3b5-5990-4380-9bf7-0097d51356bc",
"_parent_id": "73f659a3-a9aa-431e-a6b6-ae3591285c31",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1bf734cd-0f77-4553-a1d2-c9fe43be4278",
"company_id": "a0e9b36e-168b-4f7b-adf7-43fc54c10f86",
"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": "0e5a464a-6cd8-42a4-a884-4609e7fcec53",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d5140cdd-4e46-4532-87f7-362d3c27f877",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "13d48a12-27c2-46e2-b032-b5c03ed89331",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c7b5d159-2e53-4e66-8d23-3bd82809d7b8",
"company_code": "sample string 5",
"company": {
"id": "8406071d-1974-42fb-bade-dc5466d35123",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-19T00:10:05.1607712+00:00",
"sales_territory_id": "07da97c1-8ccb-47b9-b343-1568a8c403d3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "733b3833-af91-4361-864d-e403c41ac91e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ab3950ac-c190-46c8-b570-2e93e983493f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "392090e0-64aa-459d-98e1-580c6dc0a0ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8f58870-64e6-476b-9801-7e9ff69820d7",
"db_currency_id": "c2e71136-042e-4d4f-adce-815a736f252b",
"db_language_id": "a40045ef-4817-482f-9079-87b2b2f686ae",
"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-19T00:10:05.1607712+00:00"
},
"modified_dateutc": "2026-04-19T00:10:05.1607712+00:00"
},
"marketing_segment_id": "9cf755e1-3eab-4fa2-b556-78b5e998224d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5ce43eb7-3351-47f4-a115-5ce3fa591ac1",
"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": "669ac01f-56ab-4e9f-bb91-4c6e3325dcf9",
"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": "5acfab2f-0a65-4f5f-9d97-8097322e94db",
"db_country_code": "sample string 28",
"feelist_id": "db2b2eeb-6231-4ae1-902d-a3500d4fe8d8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c062bde4-0b57-4b3e-a6a1-fa148a74f476",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "09c31c71-9701-4fe8-8e75-ed074e6a2287",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-19T00:10:05.1607712+00:00",
"db_currency_id": "b2fa9edc-06e7-426c-aa77-d9531a072c55",
"db_currency_code": "sample string 10"
},
"company_type_id": "c835d599-42e1-420d-944a-cbd67b1c0a66",
"company_type_name": "sample string 32",
"company_type": {
"id": "60600d66-8456-4c0b-a378-f5d36878bf76",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c2bec34d-1aff-4699-978c-61129b11ca82",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5b90a814-4b1f-4a39-b22c-610e05c33cb2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "75cbc57d-cc6b-4887-98b4-b7ac0f7a0e05",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "685b9f88-87ea-4cf1-a545-f69c833fb947",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8ea8cd06-0c35-4120-976e-9be8f92df9bd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-19T00:10:05.1607712+00:00"
},
"company_sector_id": "ce31d818-ec65-4149-bd04-f0228020f472",
"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": "32b3ac26-e328-4592-949d-9957769a3999",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d9e7f89d-b233-462f-80bb-9c46be1c5c53",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6799b225-57e3-4b4d-86b2-4848d6802bfa",
"account_manager_user_code": "sample string 56",
"company_status_id": "43d0bc4d-143d-4f3d-9bdc-066e6a5508b2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-19T00:10:05.1607712+00:00",
"id2": 60
},
"db_language_id": "fb9fa849-2e58-4f88-827c-f812fc51a25a",
"db_language_code": "sample string 7",
"db_title_id": "faf61a3b-4c97-4c30-a7f2-4c6954ed4f6f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-19T00:10:05.1607712+00:00",
"create_date": "2026-04-19T00:10:05.1607712+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-19T00:10:05.1607712+00:00"
},
"modified_dateutc": "2026-04-19T00:10:05.1607712+00:00",
"id2": 22
}