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": "39337b2a-4f29-42de-932f-7b4af5d89a22",
"_parent_id": "e178a175-2ff7-4774-89ea-8c331461222c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1c68acba-b86c-461a-ba80-11338f31e9d2",
"company_id": "93d2b31e-57c4-40fc-8fca-f44bde5abe83",
"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": "b298613f-446c-4ead-99fc-770efc5e75ad",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6e49aa5e-e28a-4829-99d7-e42c314e13e2",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "36eac544-5ddd-451c-8846-0ae95b258ac4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4415634d-1788-4155-bc99-7c2fc7b305ac",
"company_code": "sample string 5",
"company": {
"id": "9ef54b56-83e2-4733-933a-081664953bf5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-18T00:38:47.6865481+00:00",
"sales_territory_id": "9766a215-5886-41ce-b27a-8ecfef23ba7a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "741ad81b-b793-4d71-93c0-281914a08740",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2cef7f84-ffd2-4bf2-b7a9-f4b610dc00f8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "09b2989f-1264-4530-bcdd-f91d618edab0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "292e5823-2831-435e-8db1-3c463d126002",
"db_currency_id": "595a0e38-b5be-4cd9-b0be-5b01b94aaefc",
"db_language_id": "c2350296-9b78-4be7-b232-28bef1408d46",
"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-05-18T00:38:47.6865481+00:00"
},
"modified_dateutc": "2025-05-18T00:38:47.6865481+00:00"
},
"marketing_segment_id": "3462a244-30fd-424a-9b6a-75970efa3c0a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "21de0cb2-f6ff-4e32-a843-49f50ba51f37",
"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": "059da568-9624-4fd4-95c4-8fadeed653d7",
"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": "cd732ea0-28e2-4052-8923-f32ead7fe8e9",
"db_country_code": "sample string 28",
"feelist_id": "7def23dc-5dbf-4143-8657-e9c0bcd5b7e9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b7ecb90c-c2c0-4e9e-aaa8-1490e1633881",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "08bfb23c-215d-4c16-a477-773e6f386c61",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-18T00:38:47.6865481+00:00",
"db_currency_id": "adbcac38-74ae-4423-a846-94fa483061f6",
"db_currency_code": "sample string 10"
},
"company_type_id": "bafb6b68-930e-423f-9280-94e84e3f3d53",
"company_type_name": "sample string 32",
"company_type": {
"id": "70bcf1e6-5f42-48d6-87c6-be852467a705",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2e8fe053-972a-4732-93be-b3f8461663cf",
"sales_organization_code": "sample string 5"
},
"db_language_id": "592c1143-20e4-417a-aac5-50d2f379c066",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c4022268-074f-4eea-b6e5-7e15f1cb8142",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b22faad9-15b9-4c9e-9196-cfe5ad196330",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8abbcc8b-b3ad-4e27-9b30-5f597d8dc069",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-18T00:38:47.6865481+00:00"
},
"company_sector_id": "92f89372-0c67-494e-a72e-06f5fb244e13",
"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": "a821890a-ed53-4203-a0ad-d7880d5f3d38",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cda1f2f2-3683-4553-a38b-7908022201ef",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a917a0a6-e3cd-442b-a412-1d43678efe88",
"account_manager_user_code": "sample string 56",
"company_status_id": "f0948e26-16b7-41f3-8f3a-30f9f5f6daa6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-18T00:38:47.6865481+00:00",
"id2": 60
},
"db_language_id": "5ff4d8d9-da0c-422c-9f21-e0f291373438",
"db_language_code": "sample string 7",
"db_title_id": "44ef6e0e-3938-45ed-ba57-f685c1973e6c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-18T00:38:47.6865481+00:00",
"create_date": "2025-05-18T00:38:47.6865481+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-05-18T00:38:47.6865481+00:00"
},
"modified_dateutc": "2025-05-18T00:38:47.6865481+00:00",
"id2": 22
}