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": "6edb642e-5da2-4c39-a8d5-17485a3219b4",
"_parent_id": "ceae32cb-3e11-4bb5-b98e-68c8546e74ee",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ccbcad38-cb5d-47ba-ba83-c53aa61e9124",
"company_id": "57b4fcba-69c4-432d-97b5-7d6957a03145",
"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": "d258c150-7e5b-4e66-b8d5-711c792db7a0",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "56031c02-b60f-4590-a8c8-31a467b04282",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "20048628-f22a-4743-b625-c47c95355369",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b6987548-dbe5-4d42-a9ff-2b44a0a10984",
"company_code": "sample string 5",
"company": {
"id": "79adfe66-baf0-47bb-b478-a03a6ebd62b4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-10T01:46:37.4453504+00:00",
"sales_territory_id": "3d5a8eff-1479-49e8-bcbb-80d6b9fd4e53",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7387fa0a-f535-48b7-b4bb-d35a460a3fbd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "50ad1bc7-6b28-45b4-a4fe-bbc4248fefc4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b5c46d9b-6ecc-44f5-b475-9325728a4a2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f15f45fa-0404-4715-97de-56682d5cb6bb",
"db_currency_id": "974a2549-2291-4189-a22d-3ded291279c3",
"db_language_id": "202d27cc-d48a-4dda-87b7-e5554562c230",
"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-10-10T01:46:37.4453504+00:00"
},
"modified_dateutc": "2026-10-10T01:46:37.4453504+00:00"
},
"marketing_segment_id": "f1d7cca4-c7ed-4f10-ab85-41fdd0b6171d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7929b09d-326e-4231-b74d-f7c74923d51b",
"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": "09c698bc-8326-4f7b-b9e8-ee2c80620a09",
"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": "50a2c5d0-b6c0-45b3-8bc8-9c94e4b6e5ea",
"db_country_code": "sample string 28",
"feelist_id": "df94d6e9-3378-4b15-8ff1-453803d21f08",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "34073550-6152-4d47-9c5c-2e195022dead",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "db1ae608-56d8-43e3-a36a-b112f72f97e1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-10T01:46:37.4453504+00:00",
"db_currency_id": "dd53d7d7-73bb-4a62-b823-66760faa921e",
"db_currency_code": "sample string 10"
},
"company_type_id": "0b74fb8c-b0c4-4a70-88a3-f2167ee5304b",
"company_type_name": "sample string 32",
"company_type": {
"id": "b4c794e2-efa6-442b-8c25-28edc17e44c4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5a048385-f2da-4d57-ab8d-7a17dd024d76",
"sales_organization_code": "sample string 5"
},
"db_language_id": "103c0251-71d7-411e-8f2e-88e5b7ab2207",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "227cfbf4-74f1-4ad6-93da-aa8731fd99f9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8242bf30-8e05-4487-ac66-2fc3da07ad87",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7cd79f68-a520-4786-a55a-f72c0184d980",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-10T01:46:37.4453504+00:00"
},
"company_sector_id": "f6014615-def2-4919-83cb-abc41575df89",
"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": "de1d6d65-0b95-406d-90d8-388f56b1de53",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2abbc04c-9e15-4b10-ac2c-d20936f8c1af",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "55d0cfbb-ceae-4939-98f7-7528a7bb1faa",
"account_manager_user_code": "sample string 56",
"company_status_id": "5aad6e41-820b-442c-b39d-6d98bbb5dabc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-10T01:46:37.4453504+00:00",
"id2": 60
},
"db_language_id": "69f6ab67-66e5-47c8-8a65-3a97b6b25d4b",
"db_language_code": "sample string 7",
"db_title_id": "2cfa08d0-59ad-43f1-8e23-0ad548dba796",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-10T01:46:37.4453504+00:00",
"create_date": "2026-10-10T01:46:37.4453504+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-10-10T01:46:37.4453504+00:00"
},
"modified_dateutc": "2026-10-10T01:46:37.4453504+00:00",
"id2": 22
}