Retrieves an object of the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
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": "8db951e0-7c92-4812-b105-a9d62f60d779",
"_parent_id": "821e1294-fd79-45a0-9b19-b9babdd88b11",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "0c277cf1-e13b-4e3b-ac2e-6a6ba989e320",
"company_id": "64312312-6e44-4e0f-88cc-c9ce6f13dc47",
"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": "b671ada5-e399-403f-89b3-ccae28ed57cf",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "361eab63-7087-4173-a2cd-a6d93bd1c3e7",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "06825139-2740-444a-866c-1d0e37fb0e22",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4d8f1652-f79d-4d1b-b970-1129f53fcc64",
"company_code": "sample string 5",
"company": {
"id": "a8d0ce4b-bc02-401f-8d0e-5ed28618bc71",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-30T12:53:56.0891908+00:00",
"sales_territory_id": "1d546c0a-c4b7-4a0f-bc65-590533cff1c6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "52ebfe81-eb8f-4949-923e-074a7bea6a5d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ddc05afa-e9f2-43b8-ab39-44ce4ebe1c50",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c4962e3f-64a3-4f5f-937d-5b364ae76d18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1de70688-ac65-413e-9456-7c8295d022ab",
"db_currency_id": "f89aac49-a732-45d0-bf7b-e1404cc16d1a",
"db_language_id": "7c5f2632-4a6a-4fc4-9a84-7dc9861d1c5e",
"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-10-30T12:53:56.0891908+00:00"
},
"modified_dateutc": "2025-10-30T12:53:56.0891908+00:00"
},
"marketing_segment_id": "e0ac1d15-4752-4731-8ffb-a1a11d8201bc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5f3ff1ce-6d92-44ee-81c5-0954177665c7",
"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": "453ddcad-f045-4a40-86ad-23546cea1ce1",
"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": "be307526-8e1e-4ae4-b17b-c666014ded25",
"db_country_code": "sample string 28",
"feelist_id": "2d8254e1-d3d4-4ea4-8e2b-4b7254535c67",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a8e6bf24-7a53-4d6c-8f98-57a7011df83d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f5f1c928-2f02-4ec0-aaf4-8f97c0242248",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-30T12:53:56.0891908+00:00",
"db_currency_id": "72b3fa77-2e96-453f-9d9e-b92c2f0d2815",
"db_currency_code": "sample string 10"
},
"company_type_id": "f563bf2f-f6c6-4cf9-965f-21f145b0be66",
"company_type_name": "sample string 32",
"company_type": {
"id": "86ceecd2-18c3-4937-89e4-785ab4950dae",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ea2c8d73-827d-4edc-91b6-49a5428c0a5e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d1b2870e-d8ea-4995-a880-5928c376d28f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "466fcc0a-4a8b-41ac-b6de-f1ca8040f589",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "15411bdd-9512-4677-8363-5e716f620e89",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c63bd7ea-79f6-4a3d-90a5-3c1ba732f756",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-30T12:53:56.0891908+00:00"
},
"company_sector_id": "7d27aa5d-a3bc-4977-8c9f-719e62fda3ff",
"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": "9de0c0cc-a5b5-47a7-a731-e2ff1a7a9a67",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d3c0079a-78c7-4d8b-949b-efa7f9d3ad3a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a041a714-929a-4e73-aa44-e590d9997c82",
"account_manager_user_code": "sample string 56",
"company_status_id": "42e70f76-34c7-4708-8d05-f4ff389b4fa9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-30T12:53:56.0891908+00:00",
"id2": 60
},
"db_language_id": "dd9f8b48-54e4-4d6a-8862-ff37fdbbce2b",
"db_language_code": "sample string 7",
"db_title_id": "6addb47e-ed4d-4dd6-a5cc-e4a25b21cc7a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-30T12:53:56.0891908+00:00",
"create_date": "2025-10-30T12:53:56.0891908+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-10-30T12:53:56.0891908+00:00"
},
"modified_dateutc": "2025-10-30T12:53:56.0891908+00:00",
"id2": 22
}