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": "eed1724a-a80c-43fc-b4b5-0d0949092955",
"_parent_id": "afa13670-41e3-4e63-af36-3061a12040f0",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "bd88edd0-d5c2-401e-931c-2dede17805a6",
"company_id": "019e685d-2561-42cd-af16-0a0d7a9ef506",
"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": "9337a8eb-2d81-4721-8e8c-18bdb50f7038",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "5a14f4d5-641e-4149-90e2-71508d7ed854",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "8d34699a-40ee-4467-885f-a28c6ef76c80",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7eefa1b2-f0d8-4de3-aac5-492fd40f4b6d",
"company_code": "sample string 5",
"company": {
"id": "9cad84e5-75c7-482a-9f18-3c3be2b90ff0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-03T06:00:55.4081367+00:00",
"sales_territory_id": "432f1506-e4fa-4a2a-b76f-740bc8dfbb79",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f4b6bbd5-7031-4478-a987-ac8940b37cde",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8587ad67-e640-4953-ad1b-7b1ddc578733",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "785014e1-d503-4e31-9ef3-d0e548163176",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d42f95cb-cbbd-43e3-8993-74927b101f7d",
"db_currency_id": "2784d08d-dc77-4f35-b03d-86dcc1729314",
"db_language_id": "3790632e-b781-4cd0-9dee-5e40f50d657b",
"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-10-03T06:00:55.4081367+00:00"
},
"modified_dateutc": "2025-10-03T06:00:55.4081367+00:00"
},
"marketing_segment_id": "f3bced87-08d6-48fd-aa33-2bed8cff8391",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "54eb5b9e-4abc-4d6c-9a9a-a36ad795c8da",
"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": "efebc65c-fd1c-4c00-abe5-daf8fd724187",
"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": "2cb50470-f6a0-49e3-b8e6-90c1766fa6b8",
"db_country_code": "sample string 28",
"feelist_id": "1fa86057-2044-4551-802f-24554f6a71a1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d1f7b20d-ee7f-4b67-9626-179655fb0935",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8c218789-5ba8-4c06-bc0f-5e46274d6fe3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-03T06:00:55.4081367+00:00",
"db_currency_id": "5fe3821f-ddd1-4ecf-8701-23612137cda1",
"db_currency_code": "sample string 10"
},
"company_type_id": "17c5cb78-4513-46e2-bf29-d4a8548641e8",
"company_type_name": "sample string 32",
"company_type": {
"id": "6855ec26-c357-44a0-b620-09f261d5b695",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "90f98983-5e00-4215-80d5-3f82c8cd77fd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b2df91c9-5cd4-4250-be76-dd9302b8d026",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "881f90b8-a9bc-41d4-8e87-ab4727b38e9d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "485215fd-22e7-4c94-aae8-2edca76cd4ff",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3268a410-6e29-4962-828f-b37ea431b111",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-03T06:00:55.4081367+00:00"
},
"company_sector_id": "91e05d9d-bd30-48a1-a0cf-f0ead7faca4b",
"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": "97faaecc-9e9b-4d27-ad9e-07f1e1844b4d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6b752a52-8590-419d-8ee6-fe7227636ac5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4869a256-e9c1-46bd-86f9-38af298f8345",
"account_manager_user_code": "sample string 56",
"company_status_id": "2f2578c3-8804-4940-a4c4-85af9675764c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-03T06:00:55.4081367+00:00",
"id2": 60
},
"db_language_id": "91d5f498-519c-46d4-a898-0cfd89060f8f",
"db_language_code": "sample string 7",
"db_title_id": "a2efe019-3e71-411f-9c6b-1dd26383c242",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-03T06:00:55.4081367+00:00",
"create_date": "2025-10-03T06:00:55.4081367+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-10-03T06:00:55.4081367+00:00"
},
"modified_dateutc": "2025-10-03T06:00:55.4081367+00:00",
"id2": 22
}