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": "2d007267-eb88-4914-b80d-0ce65cf79ae0",
"_parent_id": "29028dda-1009-4577-b2b5-8a44d29b69e8",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2f7bffb1-7a27-4e88-8934-3e3dba6e2c00",
"company_id": "538f75b7-3df0-49f4-89d6-3764c8796d92",
"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": "3543a30a-8cd1-4af4-be36-7a85125a040f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "468fa9d0-33e2-401e-8795-9b906c9ad847",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "70b66afd-7eb7-49ab-88b2-1f17f07ce0ab",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "aed148cb-225d-49c7-82b9-5e05e0a001f0",
"company_code": "sample string 5",
"company": {
"id": "dda6d09d-b7c9-4b5e-8ffe-725dcddd254c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-13T19:51:58.0033449+00:00",
"sales_territory_id": "e7f5f152-a0fc-4fc3-986c-f140dc487d53",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b0cfc66a-b576-43dc-9dc7-35ec593dfde3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bfd5f53f-e9cf-42d0-b10b-52f7e91f854d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "411a8077-8853-4a6e-9f5b-06699aec9e65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f4d79345-c734-4c3e-816e-646243b416de",
"db_currency_id": "21b408c7-006d-4bdc-a55c-abc7e5e8be19",
"db_language_id": "302261e3-73ea-4e26-a0a4-f35984ca20ed",
"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-13T19:51:58.0033449+00:00"
},
"modified_dateutc": "2026-09-13T19:51:58.0033449+00:00"
},
"marketing_segment_id": "ccc7d391-520e-4b41-9a32-97a57e994264",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "932446f9-f147-470f-91d4-3c52e17c479c",
"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": "c0edd055-0069-4ee6-b3ae-c240aeab2cab",
"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": "6fcf7b0a-61a7-4db5-95e6-0741baa6a4df",
"db_country_code": "sample string 28",
"feelist_id": "d7a2193f-8bee-4b89-9577-1eae0edfc9c8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f07400a3-93ee-4b5c-b696-b7a6eeae6812",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "aacfe20c-5809-467b-9358-f50d46462d87",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-13T19:51:58.0033449+00:00",
"db_currency_id": "9fcad3e7-5266-475c-acf2-85d0f06d3d0c",
"db_currency_code": "sample string 10"
},
"company_type_id": "62341c68-69d8-4c4e-8df7-022c6a4fc905",
"company_type_name": "sample string 32",
"company_type": {
"id": "ccb9cab6-34ab-4192-86c3-70620e9b8236",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ee2a6377-d098-443f-9165-b97f5e0c0ad8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "cf47c6fb-7036-48f8-86a3-db09b05c05fd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b1ff74f8-f58b-47fe-925d-45ca5d7ef4e4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2faf29f3-ce9f-4dbb-a9b4-359a87adc3af",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "988f36d6-eea2-4f0f-850c-ba4680ed823b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-13T19:51:58.0033449+00:00"
},
"company_sector_id": "cb853c4e-1ace-4734-b20d-4168342b6cb7",
"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": "d1362faa-fcc7-4460-8910-f587ac039c17",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "917eb19d-d96a-442a-a470-b58bd7f52c7d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "10521a1c-0d54-4dfd-a7fe-1b78bce01cde",
"account_manager_user_code": "sample string 56",
"company_status_id": "3034fe48-9e33-4b5e-bece-b273d1559f8d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-13T19:51:58.0189636+00:00",
"id2": 60
},
"db_language_id": "69591d1e-4d62-4534-9da4-c8d9bb7cc8bb",
"db_language_code": "sample string 7",
"db_title_id": "2844c84c-3f9e-4f1d-a4e0-2387c4268603",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-13T19:51:58.0189636+00:00",
"create_date": "2026-09-13T19:51:58.0189636+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-13T19:51:58.0189636+00:00"
},
"modified_dateutc": "2026-09-13T19:51:58.0189636+00:00",
"id2": 22
}