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": "2239f4e1-e14f-4f3d-8cf2-a4970fc17695",
"_parent_id": "83832de8-5cdf-466a-af3d-5f7d10951207",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "af0730aa-23b1-4461-8420-1d86035b34cf",
"company_id": "27fd6cc9-e5a7-408a-97f3-87309bb8d2b1",
"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": "17e6fdfa-8249-4b4e-a8f4-ed159bb148d5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "1cc9c77b-8d20-45a2-9486-9e01a67aa425",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6b395e29-f757-4004-8e23-cb962e823dbd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "40c9b1ac-6c05-44e4-81b3-de76abc6b960",
"company_code": "sample string 5",
"company": {
"id": "fd7141aa-9abc-4db8-a4bf-19c47a27b6f5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-07T07:36:20.6460026+00:00",
"sales_territory_id": "5c4af6f7-9ca8-4524-8ba6-8f640100e776",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "504d0a95-0ded-49bd-bbde-09524238c624",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a6a4ca91-3bc3-452f-b6c8-2e0b4517b406",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8caf5ce3-77df-4f12-884d-63b837ae6dd1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8dff9e49-5cc5-4e04-8317-68c146a9ff78",
"db_currency_id": "aa52044e-1523-4f08-8f69-10aa449348ac",
"db_language_id": "861a0a3a-ec1a-4df1-bd55-e9072476713d",
"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-07T07:36:20.6460026+00:00"
},
"modified_dateutc": "2026-04-07T07:36:20.6460026+00:00"
},
"marketing_segment_id": "cf67b44c-5287-4880-ae78-50d04652a388",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "35b7ff30-ef7c-4d9d-8cc2-cab19c631d9a",
"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": "b6cf8e59-0862-4d34-86df-13c99d7dfdd5",
"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": "7f977034-df7b-40bc-bb62-5909a2b452b3",
"db_country_code": "sample string 28",
"feelist_id": "7802c9ff-8866-4f48-9ab5-068c0e9d6dd8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "90631808-0a1c-4f08-a4b4-f6c3a76ae947",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cb4a6ec0-4459-4c0a-8e83-4f6f67f5ca67",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-07T07:36:20.6460026+00:00",
"db_currency_id": "067a21b2-1fae-47c2-97ed-0b897f76893c",
"db_currency_code": "sample string 10"
},
"company_type_id": "3b69abf2-47aa-4aa2-8793-21b4f8f1a20e",
"company_type_name": "sample string 32",
"company_type": {
"id": "11cd6371-e1bb-4f21-b1ef-9e557878ad7a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "29a63998-aade-4ec5-956f-30b794a9e002",
"sales_organization_code": "sample string 5"
},
"db_language_id": "20879029-383f-4a34-bb0c-8e02685acf4d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9eb220d4-5e3d-4a81-ac01-39bd77482a31",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1f8a9b9d-b702-408d-aa6a-c9a570dd9405",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "78f5afae-390d-4a5c-bb43-324acf0d3d52",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-07T07:36:20.6460026+00:00"
},
"company_sector_id": "079918e3-4afb-4956-b196-6ae8ca13d41d",
"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": "5aefd2d3-ae03-4c8b-9409-c36f24fa0a33",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c3782034-7be9-46d4-8db6-3f4a1cbc33dc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "df9ea1ca-6974-41c5-aedc-2eccca6975bf",
"account_manager_user_code": "sample string 56",
"company_status_id": "3dcc4a21-8828-420b-a4e3-498d1761f17c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-07T07:36:20.6460026+00:00",
"id2": 60
},
"db_language_id": "f5028100-3f95-4bc6-bbb3-3ed58171aaca",
"db_language_code": "sample string 7",
"db_title_id": "9af4b9df-5931-4ac2-bc3b-494513d7978c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-07T07:36:20.6460026+00:00",
"create_date": "2026-04-07T07:36:20.6460026+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-07T07:36:20.6460026+00:00"
},
"modified_dateutc": "2026-04-07T07:36:20.6460026+00:00",
"id2": 22
}