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": "0f556d49-0263-4a9f-94e0-64901d01837f",
"_parent_id": "74113256-f825-4d50-b582-6852aebeb5a1",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "7bf8603e-d955-4ca9-a999-4e2bc95319bd",
"company_id": "320ff35d-d17e-48ea-b274-8a8ff97e5975",
"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": "5d9f8f5c-5d7f-4352-b6b5-86b2029ab6d4",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "65b4c295-d5d1-40dc-82e0-ff83ca3e3a46",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9b6bc56d-380f-4bb4-93e5-30937c6ec2e7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a8fbeddd-1a1e-48ef-8d8e-1222364708e7",
"company_code": "sample string 5",
"company": {
"id": "f9233775-a9e7-4a01-81f0-9284de89ade6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-15T16:08:47.9360188+00:00",
"sales_territory_id": "e8684fe8-6d03-4c84-a2db-ad1e1d2205e5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "06d1bc8a-304a-416b-9fec-a032bf7bb322",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9f5f8e69-5dde-4cac-8260-e68a4f0641d5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fec21076-61f9-4561-89ce-a57d047ae249",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf3424d3-b11d-4934-b1b7-7730cef2c10f",
"db_currency_id": "d64f408b-a0c1-4554-894c-85b6c6a477d8",
"db_language_id": "bebf06f4-e464-4d03-a011-5bb9115be4d6",
"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-05-15T16:08:47.9360188+00:00"
},
"modified_dateutc": "2026-05-15T16:08:47.9360188+00:00"
},
"marketing_segment_id": "4a48ffca-e9af-4870-b7e4-fdd3ec9b56c7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d6626fe9-fefb-4371-bab1-e108ef61c3ea",
"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": "2cea08dd-3777-45c9-847c-d8df517965ca",
"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": "73b20305-3d79-4de0-99ec-5182b5014ccd",
"db_country_code": "sample string 28",
"feelist_id": "9fae8ab5-8deb-4a3e-b421-29d074d78a23",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "507568a0-ecb5-4812-88b7-e9f456d9a3b1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1f8c34a0-cfb5-46b5-b332-93b55a79c99d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-15T16:08:47.9360188+00:00",
"db_currency_id": "858921bc-97bb-4e63-ab07-3a21094d1d92",
"db_currency_code": "sample string 10"
},
"company_type_id": "47209cc0-a62c-4d39-b0c5-c9ab7d7ee7ca",
"company_type_name": "sample string 32",
"company_type": {
"id": "4a4dd456-8ef8-4960-8d50-89107f91c264",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "98d25449-d60f-429d-bc1c-feb0ddd5e8c1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "61f4f4f2-f6d4-48e8-bdfd-d6fc7f9a923a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dc205fef-91ae-429f-8f26-de6bb6c244a2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0c2520ab-4d68-4f2e-9e94-b3327e778852",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9b500b1c-a25b-4c6d-9ebb-f558036b5aa1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-15T16:08:47.9360188+00:00"
},
"company_sector_id": "fb0eb341-b404-4787-8acc-d80df0bd6c95",
"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": "d90cd19e-9c20-47ad-87a9-d49f88739ca8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "be19c064-51af-4b93-a806-9ae6e2f1761d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e8dd180c-f850-4e77-96e8-d7a019024b1b",
"account_manager_user_code": "sample string 56",
"company_status_id": "b2797df0-d284-4118-abb3-8ccb188f076e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-15T16:08:47.9360188+00:00",
"id2": 60
},
"db_language_id": "3e8a9953-c177-4870-9a6d-ea3618128a2e",
"db_language_code": "sample string 7",
"db_title_id": "03470449-fdcf-437a-9107-14a113371371",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-15T16:08:47.9360188+00:00",
"create_date": "2026-05-15T16:08:47.9360188+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-05-15T16:08:47.9360188+00:00"
},
"modified_dateutc": "2026-05-15T16:08:47.9360188+00:00",
"id2": 22
}