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": "83e506bc-5e95-4147-9cb5-2318cdab0011",
"_parent_id": "aa60b0df-38fd-4da5-818a-63b47da73ca9",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "5cda8069-87a2-40de-9c69-ec94c77d680d",
"company_id": "14b1a2a5-2c97-470b-b049-5d8526d5d7ca",
"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": "b0645b2b-1393-4ece-af51-7177dfbf77a2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "991a5681-252b-4618-b9c5-d6a753645522",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "41bf2f09-76a0-4449-8709-6e55a741cd0d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "88a8614c-6bff-498d-8306-9b49838baa61",
"company_code": "sample string 5",
"company": {
"id": "d802a383-4048-462d-a03a-537b69aad79a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-25T14:33:14.3573789+00:00",
"sales_territory_id": "38585e30-3b61-4fe7-8243-be3a27c14943",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b3aa1a0b-0552-48ae-b1c4-f02b6c3b7e5d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a2fab5f5-5cb7-4392-a186-8c91c135627a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d10f5d98-b0aa-41c4-a076-a0f63c0d15e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7066d88c-5123-479b-bfae-7b1268cdc59e",
"db_currency_id": "b073cc8c-4847-46b7-9bd2-c8e427334ccd",
"db_language_id": "f65d566b-53b7-4e4c-9203-634f35c7505e",
"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-09-25T14:33:14.3573789+00:00"
},
"modified_dateutc": "2026-09-25T14:33:14.3573789+00:00"
},
"marketing_segment_id": "68b90190-7ade-441d-9b36-47731786232b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d1746a69-45c2-414e-acdb-2fffbfd2a0d2",
"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": "e35c8566-3db4-45ec-9772-4708d8292b4d",
"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": "626b8936-e931-4a10-a8d8-3541ae15fdd3",
"db_country_code": "sample string 28",
"feelist_id": "0bbc1174-44e8-47b8-9143-e8eb45732e59",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6e02a0dd-6ddb-4807-86c2-8326e104c3d4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9d4762b2-a9f8-474e-ba71-5a7b51f2aca6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-25T14:33:14.3573789+00:00",
"db_currency_id": "5eb03e92-7f6b-4b85-9f0c-af429381e42e",
"db_currency_code": "sample string 10"
},
"company_type_id": "a032073a-89a6-4bf0-b6e2-8dd9a2b0df0a",
"company_type_name": "sample string 32",
"company_type": {
"id": "478fecb9-cf6c-4598-a97a-c9f31351e200",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6516ff28-8bd9-4e77-935a-bbb6175e5c9d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "82cda888-bbab-4c5b-9ca2-a03ebb45556e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8a3c2e44-c0a5-4176-b275-16d49ba8d6a9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e4f79e17-0e7b-473c-9224-e8e99d5662c5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "aa2085cb-464c-4c5a-8a7e-0035084fbdb3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-25T14:33:14.3573789+00:00"
},
"company_sector_id": "9a3f555c-38d2-4463-9420-442614ec525f",
"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": "c8a663f8-660f-4e2d-ac13-e4469eb2c7e9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a6bb4b40-623e-4570-bb61-a318082f2489",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e666409c-f3e3-4a2a-83c7-a51a9a08682e",
"account_manager_user_code": "sample string 56",
"company_status_id": "7a3a29fe-8031-4b24-8689-42cf0798ba17",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-25T14:33:14.3573789+00:00",
"id2": 60
},
"db_language_id": "f7ea0221-472e-4153-ba4d-3862996e02c8",
"db_language_code": "sample string 7",
"db_title_id": "1bdd94a9-a82c-4b14-9483-1bee03eda702",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-25T14:33:14.3573789+00:00",
"create_date": "2026-09-25T14:33:14.3573789+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-09-25T14:33:14.3573789+00:00"
},
"modified_dateutc": "2026-09-25T14:33:14.3573789+00:00",
"id2": 22
}