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": "0d5a116e-1a2c-48e8-8e8b-1864b0b26644",
"_parent_id": "0420d113-5693-4e0b-b48e-0ced04a4c1fa",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "4fac80bd-19c2-4033-b771-0d7eae8e7147",
"company_id": "af1ac532-7405-4e82-aab7-db7514d37a73",
"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": "bf95aa2b-2e0b-4b6f-be0a-e59f2830906a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "783fa5a0-478f-470e-af1c-c891a036b233",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "8d03b333-ce5e-4d5e-98ab-d099f9e18783",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "86896dfe-3e4d-46e2-977b-58db52215509",
"company_code": "sample string 5",
"company": {
"id": "01cb9dbb-5b0d-4fb0-b0cc-b674fa7d35ee",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-14T01:11:00.4153835+00:00",
"sales_territory_id": "8ea98121-3a5f-4f94-bb98-c24c71de5d53",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ab10406c-9953-45ac-a407-7eb0b7fdd89a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1da79ce0-15f2-4dc5-ab9e-712ff0151cb7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aec81856-9bf4-4772-babb-5b399a4ba207",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63b12d1a-b1d2-490f-a4a9-56f87b661498",
"db_currency_id": "d20b26d8-f9db-45ce-bc11-204907a9eb30",
"db_language_id": "42ca05d5-c831-4c79-b8cc-829e6ea7de9b",
"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": "2025-12-14T01:11:00.4153835+00:00"
},
"modified_dateutc": "2025-12-14T01:11:00.4153835+00:00"
},
"marketing_segment_id": "30645db3-8191-400b-8dd8-3ddf011942c8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f3c7d42d-e439-44c9-9897-b1fb6c847ba4",
"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": "eeb38978-a03a-402c-96e6-0c2fc19521ac",
"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": "e26c9ef4-a57d-4908-bd7b-6a3d178cc16d",
"db_country_code": "sample string 28",
"feelist_id": "eaba618b-e819-498a-aacb-538d6afa675a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8cdf2b7e-7778-49fe-bef4-7d6fbc608a8b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9236ee1d-a0e6-48e5-a9e5-3c3063c5e149",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-14T01:11:00.4153835+00:00",
"db_currency_id": "ee75b977-00e6-496d-b07a-b15a4d15ac2f",
"db_currency_code": "sample string 10"
},
"company_type_id": "e2e2f269-a42e-4b5c-a0f4-5cdbff55840b",
"company_type_name": "sample string 32",
"company_type": {
"id": "4d03f84f-88d9-4d21-9997-644401b588e3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "10ed29e6-2681-42ff-8e42-04b71d3504ea",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ce93094a-6d3f-4b0d-8898-e6e71b1b8fd7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7aea0e58-32b7-44e0-91f1-8a4c681df3b2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "59cea8bc-c941-4da4-b8b4-8e59d38cbdbe",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "205e51e9-a7e6-4b9d-abce-5410d5f31dba",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-14T01:11:00.4153835+00:00"
},
"company_sector_id": "b98b1e0f-47b6-46d2-a60e-5bca3016fe93",
"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": "7690302f-380b-4d2c-9d72-a709090a0e81",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "00523aab-2289-4494-9dca-5b6e3c8b7359",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "347e1fcd-474f-42e8-a8b3-c186f92036b8",
"account_manager_user_code": "sample string 56",
"company_status_id": "a85f9fea-a594-48c3-b430-f55cccf53206",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-14T01:11:00.4153835+00:00",
"id2": 60
},
"db_language_id": "3d93281d-a172-40f9-892b-163d0ec74749",
"db_language_code": "sample string 7",
"db_title_id": "3d81e9c8-5770-4a9f-a20c-847c17dbb4a8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-14T01:11:00.4153835+00:00",
"create_date": "2025-12-14T01:11:00.4153835+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": "2025-12-14T01:11:00.4153835+00:00"
},
"modified_dateutc": "2025-12-14T01:11:00.4153835+00:00",
"id2": 22
}