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": "994af981-0b1d-4beb-827b-91464c0c9d3e",
"_parent_id": "d77bce6c-8fde-467b-b3af-27462b550133",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "58bd7be8-383d-4652-8ac6-fdeb1f7d5f72",
"company_id": "803f9731-4a0e-430e-b4a3-51832eef1d0d",
"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": "f8e2817a-ed95-40a1-9924-62e298f446c7",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b8576b86-1315-495b-9bba-748e35a1f8e2",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "7822fbb3-a80f-4687-ad87-3803a3380f18",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "16af76f7-0dee-4dab-a780-29029318ee86",
"company_code": "sample string 5",
"company": {
"id": "907b9566-0795-4489-a1d6-03ef56c5b71c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-10T13:52:09.0767052+00:00",
"sales_territory_id": "93724f1f-414f-4d72-aade-dcf025f2a21d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "46cda267-73ec-4868-9c98-563ee7fa888e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "140fe89e-a4fb-4731-b9c8-74b85d29f37c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "32eb3f60-d5f9-4fa0-bb23-be58cdbafb3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed3a716a-992a-4b55-a0e2-b664bede9c76",
"db_currency_id": "a3371ca6-1672-4062-9055-541c73baa7f6",
"db_language_id": "dd327912-e0cb-4467-a5b4-df069efc9df3",
"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-02-10T13:52:09.0767052+00:00"
},
"modified_dateutc": "2026-02-10T13:52:09.0767052+00:00"
},
"marketing_segment_id": "e206644f-cb98-4123-88d2-b2dd079f18db",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3db23efd-5783-49e2-ac1f-d4a3c9344513",
"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": "ca31be32-28c6-4440-941f-71b6ebe6da28",
"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": "cad66e14-5483-4146-8468-59470ab03a8f",
"db_country_code": "sample string 28",
"feelist_id": "c29b64bf-67e2-46b6-bac2-d8963945dcc3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fd9eecc0-a510-42e0-a56a-f33d7f0a0639",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "771a87cb-dea7-4bf7-9862-c9b77a31d8fb",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-10T13:52:09.0767052+00:00",
"db_currency_id": "abb4beeb-49a2-4a84-af7b-b7d16b497ff8",
"db_currency_code": "sample string 10"
},
"company_type_id": "66e97f04-806f-43a1-8a05-b7ddf062056b",
"company_type_name": "sample string 32",
"company_type": {
"id": "d23664ff-f6a5-4a09-8657-46f5c07ee0b3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "853a51a4-6023-4f7c-ba8f-e68c97f327b9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4134e2c8-b43d-4bf7-bb4d-8467e4d28bf5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e85c5498-5690-4fb4-bdac-60f565a467c8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c475849d-7a54-445d-8118-3d88ef6705aa",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4704f325-63ab-4cdd-be51-01e2e2df5988",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-10T13:52:09.0767052+00:00"
},
"company_sector_id": "e9da65b6-99a4-4180-938d-0e691359a90b",
"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": "e7d60434-6957-45f5-8b05-14fbe4ba3a05",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8ef51e87-b85d-4824-9a8f-005395032234",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2942ec7b-96fe-43b5-a8ad-f726a1035189",
"account_manager_user_code": "sample string 56",
"company_status_id": "11544598-1225-4969-906b-5311693259db",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-10T13:52:09.0923425+00:00",
"id2": 60
},
"db_language_id": "04d44d93-325b-47e2-9801-6a6d565f125e",
"db_language_code": "sample string 7",
"db_title_id": "a77a929d-257f-4bfa-9e6b-8c18ad8365b0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-10T13:52:09.0923425+00:00",
"create_date": "2026-02-10T13:52:09.0923425+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-02-10T13:52:09.0923425+00:00"
},
"modified_dateutc": "2026-02-10T13:52:09.0923425+00:00",
"id2": 22
}