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": "2155af23-2b27-41f9-a700-aca7579c175f",
"_parent_id": "949cbf39-cbcb-4c8b-b460-6c7975feb359",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "aee741dc-a4fe-47c3-83a6-24c627505bd3",
"company_id": "ddc0230a-b462-4922-a284-9afa734a8064",
"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": "8406c365-1ec8-4d20-84c0-9be062f58396",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a9654852-0269-4bf1-8eef-017fd2b202f1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f5f04295-d2f5-466c-9574-40863ac7f5f2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "aabaaf6d-fdcb-425f-939d-ccbea3de2d46",
"company_code": "sample string 5",
"company": {
"id": "cc306367-ed75-4d70-96ed-734af921d197",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-01T03:34:22.633801+00:00",
"sales_territory_id": "26d7c306-afce-4bc8-8bf6-6e7a76818b7c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a960c2ab-32ba-48ad-b095-4f698a56d8c7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5c30037e-cd86-4990-9944-35e397190332",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7d37fcff-4e76-48c5-b952-460bc1f76981",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9263289-663f-4345-af0d-b7baaae52996",
"db_currency_id": "c3a6ba94-7c80-4ccb-b5a3-57c4ec212a90",
"db_language_id": "9fc7d511-9132-4b52-bff3-6e25d9bca96c",
"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-01T03:34:22.633801+00:00"
},
"modified_dateutc": "2026-09-01T03:34:22.633801+00:00"
},
"marketing_segment_id": "f3a98d57-aa13-4abd-9021-f768723e6146",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "78d95e13-afc1-416b-b614-1d11c810fd34",
"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": "46a780d1-927d-4128-ae93-5a26dcc2ab64",
"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": "6ee6a254-ef29-483f-b82d-3955a539a2a2",
"db_country_code": "sample string 28",
"feelist_id": "1255a835-c74e-4170-899a-e169f5206053",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "babdbee0-6899-4d5c-9349-8927fa4df3dd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0dc136cb-13ec-4fc5-9fa8-255debcb158c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-01T03:34:22.633801+00:00",
"db_currency_id": "1394df55-1a78-44e7-b0f9-a14e4fed784c",
"db_currency_code": "sample string 10"
},
"company_type_id": "158ca5d3-3817-47f2-956d-4276060b49df",
"company_type_name": "sample string 32",
"company_type": {
"id": "9ab14088-a7a0-4b71-ba7c-615bb89de1ce",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e95b08b1-3d26-4ebe-8f28-7fb24359dcb0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0048879d-cb12-4472-ba61-38af544bc39e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "19b32526-b08e-4295-b1be-a6dd122e54c9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e3b6babb-9f66-49f3-9940-215c783493e8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "20a53849-1263-4e29-bb41-b323f9b67aa9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-01T03:34:22.633801+00:00"
},
"company_sector_id": "13c2cf45-13ef-4017-86fb-b868354e8557",
"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": "9164257a-9cca-41a6-8a9e-ed96a0e0e99a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d17154d8-2902-4b5f-9136-b8b6ca9868f0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a73350c3-7af9-4d52-81ac-67c2a87fe7f6",
"account_manager_user_code": "sample string 56",
"company_status_id": "85e942f2-3e57-413a-b3f2-ad550003ec51",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-01T03:34:22.633801+00:00",
"id2": 60
},
"db_language_id": "4bf6a6d2-1033-45bf-ade2-47b68aab899a",
"db_language_code": "sample string 7",
"db_title_id": "1257ccd0-7913-4bfc-92a8-799303d0e662",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-01T03:34:22.633801+00:00",
"create_date": "2026-09-01T03:34:22.633801+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-01T03:34:22.633801+00:00"
},
"modified_dateutc": "2026-09-01T03:34:22.633801+00:00",
"id2": 22
}