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": "d84208c3-4183-451d-91e9-684355c36ccf",
"_parent_id": "e3643b49-b86d-4eca-873a-a1ddc2207cdb",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "539c02b2-8ee0-48fc-bf5d-64985bc552af",
"company_id": "8becef9c-c844-4276-8c7f-fd52cd861fe2",
"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": "5806e178-f794-43b1-8917-0880eaa0ebeb",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "155ce617-83b9-4f0f-813d-63864a7ef665",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9f68789f-322a-4595-85b3-2152d4d848ff",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "486eb25b-f277-41b7-b6b5-24ac95c9c6e7",
"company_code": "sample string 5",
"company": {
"id": "643e1241-2930-4bf2-abcc-acd54b9cf123",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-15T02:59:36.7912292+00:00",
"sales_territory_id": "98ae597b-8593-4f34-a8ad-a70a3d3b9358",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "851736a3-63e4-43b4-b57d-34a993b25db2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "627bf877-c32a-40be-9490-99c070cdbe2f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1ff8c102-3c27-4c22-b705-dba86f5952e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a6f162f0-ff1b-45dc-b39d-552d03cd5b98",
"db_currency_id": "070ac59b-8189-4c8e-973a-505e6a3fa7cf",
"db_language_id": "4bc308be-5ba7-4e81-9332-1f9422aeb70f",
"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-08-15T02:59:36.7912292+00:00"
},
"modified_dateutc": "2026-08-15T02:59:36.7912292+00:00"
},
"marketing_segment_id": "0244ec88-05d8-4a57-a48b-1aa2a07bb714",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "00cec5a9-80b4-4353-bc55-e92f10c2109b",
"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": "0885c482-f0a1-423e-b055-17498db70a1f",
"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": "e8feb8da-a582-488e-8e7a-591d8d159196",
"db_country_code": "sample string 28",
"feelist_id": "dd9fb2c9-a932-419b-8653-6753e2f939f0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "857183a7-2e13-49c6-9ee6-aab155100d14",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6713482e-a306-4ff9-a094-6c171125096e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-15T02:59:36.7912292+00:00",
"db_currency_id": "f168980e-3d98-478c-9ede-35c3b7d3f6dd",
"db_currency_code": "sample string 10"
},
"company_type_id": "07d5d08c-c1ee-4a92-908e-4249a70a1573",
"company_type_name": "sample string 32",
"company_type": {
"id": "eb310b4a-91c1-4e10-a2d0-643cab8eaf89",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0af3f6b5-d2d9-4117-a077-9360ce415604",
"sales_organization_code": "sample string 5"
},
"db_language_id": "889e5168-5ed1-462a-a0fd-d1dc9424471c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "00d0f331-0819-4afc-ab78-369a5505acd7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "011387e3-4229-47a9-8c35-b6a0cd30661f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "39665d8b-0941-4217-8954-6c17249fe176",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-15T02:59:36.7912292+00:00"
},
"company_sector_id": "422dc84e-7998-4d37-9863-194b9508ce73",
"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": "a02d4bdb-e7a6-42e2-8590-41360c26039c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a92570b9-19b1-44f7-a2b2-e3247fdac507",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7feee4e1-d31e-4803-879b-90b0ad6fd4a0",
"account_manager_user_code": "sample string 56",
"company_status_id": "7ff30d85-bc57-4830-a3d1-4f780ee16ab0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-15T02:59:36.7912292+00:00",
"id2": 60
},
"db_language_id": "9c39f9b1-3a82-42f6-b6b2-59d1ec25b8ef",
"db_language_code": "sample string 7",
"db_title_id": "2c84741d-f11f-49f5-abf2-c0d23fb024bd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-15T02:59:36.7912292+00:00",
"create_date": "2026-08-15T02:59:36.7912292+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-08-15T02:59:36.7912292+00:00"
},
"modified_dateutc": "2026-08-15T02:59:36.7912292+00:00",
"id2": 22
}