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": "c33c9268-9b1b-420e-9cbb-ea66e762023d",
"_parent_id": "44af69e7-e36d-4564-9e31-427125d46c89",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "5958ca82-7a9c-4628-8933-889803ff400c",
"company_id": "6f48a657-9a31-451b-a8a1-24cbe56ca392",
"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": "44c8c1f1-8b63-4b6f-b15d-3341dbe8e37f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "069cbbfe-5f6a-4778-82f3-aef7fe586566",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c710902a-be53-4d86-827a-7c829ba5a21f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0413b50a-51cc-4e7b-8a6a-633223396632",
"company_code": "sample string 5",
"company": {
"id": "1301ecc4-9a84-4a36-8c06-a048d07ee06c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-04T13:29:39.9355781+00:00",
"sales_territory_id": "9fc9e5b1-603f-43e8-bee4-25d6a31e0fd0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "685903dd-46bc-4d4a-a238-2cfaa8e7c21f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cc6014cc-2338-4e5a-bb62-00547b02e4a4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5343d1d0-1e74-4b6e-a048-1198fe3d7bfa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b788e7ff-a72f-43c8-bae1-d6e38c6c92b3",
"db_currency_id": "c9b758f9-a301-42e3-bf7e-f839b42cd12c",
"db_language_id": "aa066dda-6248-4eb3-90ba-67c29ef2ed11",
"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-11-04T13:29:39.9512052+00:00"
},
"modified_dateutc": "2025-11-04T13:29:39.9512052+00:00"
},
"marketing_segment_id": "1b8555a0-8c97-4b16-aaed-1c8ba9db1ed8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2063fa77-b982-490b-97c8-b160088fa0e9",
"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": "46061d19-9492-40a5-a3f7-5d8ac60ee691",
"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": "fd265d9f-8df3-43f2-9e6f-54f7f838a159",
"db_country_code": "sample string 28",
"feelist_id": "9ce95249-5cdb-4a61-8ee8-bd8cc1c7b67c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4520db82-9df0-4734-87bc-a416f9b5dbd9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fe0f4a7d-5388-482a-9dc3-b9e3ea6a6fad",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-04T13:29:39.9512052+00:00",
"db_currency_id": "b7edd740-4829-43e2-a0c0-875666e47f29",
"db_currency_code": "sample string 10"
},
"company_type_id": "b11e0cda-94f9-4465-8f98-14858a0da166",
"company_type_name": "sample string 32",
"company_type": {
"id": "ebdf4bbb-5a04-4e9c-89b9-0048ceb8d241",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cdbd3308-9e90-4110-b27a-2aac1bcfcbd5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "76f5b9a4-3d50-4d4a-bcfa-423216696e80",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "20250d38-edeb-4619-9751-0004644f33d0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "dfaa3ad3-804c-4bb5-a6dd-ca052e9f62fd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e5444ddf-0f9a-4e60-9c4e-1ab3e463b887",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-04T13:29:39.9512052+00:00"
},
"company_sector_id": "4d30e7d4-d305-480b-8487-b607694b0288",
"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": "60c9a70d-4937-4160-bf0c-ce26ac664df4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a339385c-d27a-4d8b-843e-0f02934b8ac7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8086fe0b-3e9f-43c1-b172-7bab127386f8",
"account_manager_user_code": "sample string 56",
"company_status_id": "b001b54e-9ac5-45b9-b7c9-babc899b7ad0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-04T13:29:39.9512052+00:00",
"id2": 60
},
"db_language_id": "8ac2dc33-d928-4589-adbe-db8dd8d62929",
"db_language_code": "sample string 7",
"db_title_id": "c6ff1b71-11bc-40a4-9dbf-ad30c147ac6d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-04T13:29:39.9512052+00:00",
"create_date": "2025-11-04T13:29:39.9512052+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-11-04T13:29:39.9512052+00:00"
},
"modified_dateutc": "2025-11-04T13:29:39.9512052+00:00",
"id2": 22
}