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": "c1acd9ce-7889-4361-bda2-c8ec6f8a249b",
"_parent_id": "4dcfa5ec-b6af-4d59-9920-860dfd2ea098",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "129cb405-d153-4222-801c-75e93e8ed85c",
"company_id": "7edfe654-18f8-4b02-a899-e8d060f2bc9d",
"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": "908b9cc5-494c-4d52-81a1-9623c882b4b4",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "50ebe7af-f640-4d78-aa2f-c6f83517380e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "951833e1-bd7e-4bd4-b30d-1097c783ebd4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e005d09a-c1fd-4485-94a6-7395eeea58ff",
"company_code": "sample string 5",
"company": {
"id": "2d3d97b2-1aaa-447a-8028-98d3f387c2a8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-26T05:41:34.6724098+00:00",
"sales_territory_id": "4feb861f-7309-431b-aadd-da9b10ee76db",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "38c3e9c8-1d0a-4820-9ca8-a19a8b9454fc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8e6dad05-76ac-4f47-9ad5-1057b9a1f625",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7d269542-bf08-456c-9bed-15bcd2b3dabb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bd7dcd2a-95ef-45fe-a580-dadce21321a9",
"db_currency_id": "57cb3867-81db-4aff-bbd7-e65179459ad7",
"db_language_id": "92b26e1c-7ca9-4114-ad7a-44a6dd5004dc",
"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": "2025-04-26T05:41:34.6724098+00:00"
},
"modified_dateutc": "2025-04-26T05:41:34.6724098+00:00"
},
"marketing_segment_id": "8159d1bc-d6de-4209-9633-745829c86732",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "adde3b6d-e536-4086-9333-7bc9a68169b0",
"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": "134442f7-37a0-4cf2-a56d-51411fb6f13f",
"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": "d0bca13a-7caa-48f4-a82d-f001c024b608",
"db_country_code": "sample string 28",
"feelist_id": "2d4ef864-a4e5-4143-a34f-c789a0647e0c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7f710930-22e0-4bc1-9f8d-266af958c015",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0eb4fe19-0c1a-46cf-85c7-d7bac19d3cf5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-26T05:41:34.6724098+00:00",
"db_currency_id": "1c63be38-42d6-4d18-8edf-5c53e714416f",
"db_currency_code": "sample string 10"
},
"company_type_id": "3ecc3d9a-523c-4130-ad8f-cd6b74f62e27",
"company_type_name": "sample string 32",
"company_type": {
"id": "5ee61821-1053-4fcc-9b38-c284bc396879",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "790b2480-c75f-4089-8031-c66b775e6c10",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c43f996a-e864-4d24-afd4-f549851c4be3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "24617692-494e-45a3-ad76-34a270d84553",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "58d372fe-dbe7-40fc-b102-7bfa6a1557df",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0ba89e39-bbc1-48f1-af87-63cb83302af1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-26T05:41:34.6724098+00:00"
},
"company_sector_id": "344d8edc-9964-4238-88dd-b41d75f059ae",
"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": "59eeb156-fef6-41de-a4a0-80d5e995ca6d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a8bab88b-a732-4fdf-a201-98e9932b9a90",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "57c17e05-d809-4d8a-9edf-4497e6a734f7",
"account_manager_user_code": "sample string 56",
"company_status_id": "788562f7-bad5-44ff-9c5e-c585db999c1f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-26T05:41:34.6724098+00:00",
"id2": 60
},
"db_language_id": "58126c01-ade6-42ac-aaa9-d5c30ed9735c",
"db_language_code": "sample string 7",
"db_title_id": "09e155cf-eac8-4f04-8633-ed3c488297fa",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-26T05:41:34.6724098+00:00",
"create_date": "2025-04-26T05:41:34.6724098+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": "2025-04-26T05:41:34.6724098+00:00"
},
"modified_dateutc": "2025-04-26T05:41:34.6724098+00:00",
"id2": 22
}