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": "f763241d-bbb4-4b4c-baa4-72b5373b729e",
"_parent_id": "7e0922f0-7057-414b-b518-8a324c7880a1",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "8542d4e5-6823-4fda-91e7-ded887afee19",
"company_id": "a6ebbde3-8507-41d7-85dd-013b175f5ff7",
"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": "7fadf07c-c48f-4205-b1f1-e589499203c3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b51c7d04-6901-4667-b7f1-8753be82c30c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "57ccf1e2-d966-4794-8062-42d860140c69",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "97184739-14e3-4ec0-9adc-27157117b099",
"company_code": "sample string 5",
"company": {
"id": "fa8442d0-4ef7-4a6e-aa68-88b974c8b697",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-18T00:10:01.1731882+00:00",
"sales_territory_id": "c3403269-9a44-4032-beee-ae3142f6b8dd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "811d1aac-a7fb-48b2-b695-9734af569d13",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "89f2f6b4-a931-4719-9f17-f1680ce94cda",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1bb7bfaa-7924-4fa4-a8dd-85ff300e328d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06bb978f-34a0-407e-827c-29553f1e9821",
"db_currency_id": "2852e0c1-27ba-40ed-b39a-e1770c5b5451",
"db_language_id": "6c9a121d-dd83-4f54-9a79-fd738873e4bb",
"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-07-18T00:10:01.1731882+00:00"
},
"modified_dateutc": "2026-07-18T00:10:01.1731882+00:00"
},
"marketing_segment_id": "2ad1eb4c-2ab4-4c20-bfae-bf9d7dc4c9d1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "10c8e131-c141-4901-9bb6-42f5ac43dfe7",
"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": "6bfde94a-81f4-468a-bea5-142ef5594b25",
"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": "08689d51-fe43-4ddc-b8c0-09d6bac57e78",
"db_country_code": "sample string 28",
"feelist_id": "e9d5d002-79f6-4d9c-97ca-fe4ce1c05238",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4b479afb-4310-4853-b154-501d9a0f83cf",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dea3e24f-15e1-4c7d-91ef-ef4af1d81c4a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-18T00:10:01.1731882+00:00",
"db_currency_id": "975a3495-7a0f-49bb-ab02-a02ea5f00f7f",
"db_currency_code": "sample string 10"
},
"company_type_id": "4a04001b-7c7b-49b9-9260-75ccb4f11480",
"company_type_name": "sample string 32",
"company_type": {
"id": "7e49497b-236e-4520-a83d-f910fa0c17a2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2d19f40e-fe55-4291-8400-02ba103dc2ea",
"sales_organization_code": "sample string 5"
},
"db_language_id": "aac1747e-df8e-455a-93c3-899dab47d7b1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a22f0745-a54c-4b5a-afa4-4d791676aa15",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "732d6b5d-88c9-4b89-a21a-1f8279845612",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "670a3b52-6ef1-4515-95a5-e4f91344ebf2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-18T00:10:01.1731882+00:00"
},
"company_sector_id": "a24e7106-253f-421a-857b-31cead7dd9da",
"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": "ea5bf5d0-d23e-4e48-8e68-1ee34256be9c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "52d34ad4-5425-41fd-8fe4-73368ac25e00",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9180d720-457d-482d-ac9f-3b651ff48371",
"account_manager_user_code": "sample string 56",
"company_status_id": "264d0e8a-7790-4182-a3a5-18c0441f66a3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-18T00:10:01.1731882+00:00",
"id2": 60
},
"db_language_id": "aa291311-c968-497d-bcdb-a1e46794297b",
"db_language_code": "sample string 7",
"db_title_id": "a4286db0-8c0c-461a-bed2-9075413ea792",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-18T00:10:01.1731882+00:00",
"create_date": "2026-07-18T00:10:01.1731882+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-07-18T00:10:01.1731882+00:00"
},
"modified_dateutc": "2026-07-18T00:10:01.1731882+00:00",
"id2": 22
}