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": "d7afd8d5-811b-4f46-a4f6-d4ff0dede737",
"_parent_id": "f8425276-66d0-43b3-9324-4d35d7da8224",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "00ac9106-4a7a-45cc-ad93-06fdbb7eab4c",
"company_id": "c65a8254-2bbf-4ff7-9b42-b85fcf64e4f3",
"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": "a620c598-db7f-4bf5-b11b-fa983fef65c0",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b5641b8f-dab3-4e3d-a239-5dd4f614abed",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "cb05aa23-375e-41ee-8651-3d174fc0c93f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ba83fd89-beb1-4773-8411-595ea4511f1b",
"company_code": "sample string 5",
"company": {
"id": "4e1737eb-7d0b-4cc8-bb1b-6e5879eb6fb6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-26T02:25:29.9990114+00:00",
"sales_territory_id": "7d7d3c0e-3926-42af-9a4e-4e6be9f365c7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "847563af-3654-425d-b16d-1b449ab7106f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9c9d15f6-ceab-49f9-9e71-532fab2acf8c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8b45ba87-cb2a-4b82-8ad6-ab018f78e301",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4705df3f-a4b2-439e-8660-becf4128e597",
"db_currency_id": "f8d4ab90-c36c-417c-9a30-cf8bce47b007",
"db_language_id": "d6d1f775-ee51-49f6-bcc0-959259b36d8f",
"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-06-26T02:25:29.9990114+00:00"
},
"modified_dateutc": "2026-06-26T02:25:29.9990114+00:00"
},
"marketing_segment_id": "d8c13a98-99b5-4d69-9155-a474ab22625e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1535912a-272c-4cf3-a295-6fae1bfc582b",
"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": "7e713a0b-5625-4d91-b7d6-59a4726796ba",
"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": "fbd51b71-8609-48d6-b7a4-21d85752fa5a",
"db_country_code": "sample string 28",
"feelist_id": "0445652b-8175-438d-80fd-7537a3e8fb0f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e07d1ea3-dd56-405f-b02b-494ea44a1717",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "21dd2d5b-b7e9-47a2-b271-208cb011ad41",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-26T02:25:29.9990114+00:00",
"db_currency_id": "d115eace-03c1-4e95-878b-771dec686313",
"db_currency_code": "sample string 10"
},
"company_type_id": "fb44ac1d-5c88-4056-8131-9e3a74f12649",
"company_type_name": "sample string 32",
"company_type": {
"id": "997e9411-b7f0-476f-820f-f5213b9d978d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2ad73758-9bf7-4333-802c-ae723f49c7d4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8447dac8-91a1-4d4b-8c3b-960d8134d1cb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "05df4d40-5cc2-478e-b82a-801154208284",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e541be8d-009f-4e5b-9ead-6967dd400b80",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2206b57d-bb53-4bb5-9376-ef235962c7d6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-26T02:25:29.9990114+00:00"
},
"company_sector_id": "01b7350c-4df7-4298-90c5-3ad1c93d4969",
"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": "ef192c84-91ff-4b24-9a7b-8520855748bd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6332e130-77d4-4511-9922-a684967fc814",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "15087c09-9dea-4fe5-9db7-cdfc5bb43276",
"account_manager_user_code": "sample string 56",
"company_status_id": "4de06b5b-dd7e-4733-ba3e-755574f1a2e1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-26T02:25:29.9990114+00:00",
"id2": 60
},
"db_language_id": "8e0e4723-30f9-4253-aeb2-2e5f086aab71",
"db_language_code": "sample string 7",
"db_title_id": "b08e3f8e-706c-4123-b154-94179c7031da",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-26T02:25:29.9990114+00:00",
"create_date": "2026-06-26T02:25:29.9990114+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-06-26T02:25:29.9990114+00:00"
},
"modified_dateutc": "2026-06-26T02:25:29.9990114+00:00",
"id2": 22
}