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": "7f7e419f-3493-4e22-96cf-22f19ab2b144",
"_parent_id": "780bea1b-9207-4fa9-8c77-5100991c00e8",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "5b23fec4-2782-47a3-97b3-fc163ac0e48a",
"company_id": "36ddf2c2-531c-46b6-b3af-bfcae77610fa",
"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": "503312f7-9712-4c60-a08e-827f13ad545a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "cc5296c9-7854-40f3-adea-3c87f9a9b6b9",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3312cc9e-1bad-42df-9f3c-07920b76ef71",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "48d4ce67-a1c7-4b42-a1d2-4b41d40e1ce7",
"company_code": "sample string 5",
"company": {
"id": "af96707e-c5e3-4324-8c09-da589f651aaf",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-19T12:50:28.8281236+00:00",
"sales_territory_id": "15e81b71-45eb-47d3-8843-644ec970321a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6ec61428-0c5d-40fd-ada2-f9d377cbf340",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9ad7faf3-c13c-40d8-8dce-d40ed8b5e0e2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8bfb9f1f-2ee8-4657-a863-45054b6913da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9775c9c7-b068-46a6-bfc5-89f4fe88ba7a",
"db_currency_id": "f4f0df63-fa30-4b18-8dc5-249b3137d2f4",
"db_language_id": "5c65639c-aaa9-4c86-a4b3-f85815e785a6",
"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-01-19T12:50:28.8281236+00:00"
},
"modified_dateutc": "2026-01-19T12:50:28.8281236+00:00"
},
"marketing_segment_id": "7f74f78e-1426-455c-83f3-505158fa91ac",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "58407dde-fb47-4945-89cc-e907ef53e60a",
"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": "0dc80903-fd1d-4ebf-8d11-fd19a25b453b",
"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": "b1955e5a-8c04-4682-adf3-44ca5349e5d3",
"db_country_code": "sample string 28",
"feelist_id": "57ef85bc-71a2-4fb4-8845-e3b992ede118",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f79e65ed-6d7a-438a-857e-f5a43e48d83b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e808a543-cd15-4193-bba1-95d2af1ea81d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-19T12:50:28.8281236+00:00",
"db_currency_id": "8c3c534d-3784-4d7f-ad30-7386d1d85eba",
"db_currency_code": "sample string 10"
},
"company_type_id": "f75124ef-e1bd-4b2e-89c5-c9f5dfd1525c",
"company_type_name": "sample string 32",
"company_type": {
"id": "02eda95a-5848-4170-87bf-d80b2d280f88",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1f446f58-3e22-4c94-9ff2-7151100f0b6c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ecf8886c-711e-450c-a804-bb8d62188926",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "01c69d31-a54d-4dc7-929d-04d312986e7a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "04fe6e35-914e-4b1d-b880-dd5aca6dbc66",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "61cedd44-92b8-4043-b20a-0a6edd592f26",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-19T12:50:28.8281236+00:00"
},
"company_sector_id": "56641c18-d3bd-4cf7-8739-44abaa6c49e4",
"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": "2b247353-0eaf-4ebb-b7de-6a5c3289faa5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e3076c3b-a8de-421d-8ad1-988906575953",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "06e1a0b3-85f8-43ac-9b9a-1b2a715a9557",
"account_manager_user_code": "sample string 56",
"company_status_id": "6429b9bc-4a72-4ccd-a97b-9dd21ff2ba07",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-19T12:50:28.8281236+00:00",
"id2": 60
},
"db_language_id": "6aeb9557-eee0-4692-b417-aef661866dda",
"db_language_code": "sample string 7",
"db_title_id": "0af99b9b-84ed-4872-b115-ca41b58a8517",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-19T12:50:28.8281236+00:00",
"create_date": "2026-01-19T12:50:28.8281236+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-01-19T12:50:28.8281236+00:00"
},
"modified_dateutc": "2026-01-19T12:50:28.8281236+00:00",
"id2": 22
}