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": "951c811d-709e-43c7-b470-0b5f539f8bf8",
"_parent_id": "72819c40-5229-4c65-90cf-cd49c5e548a8",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "996f09c1-24a4-4036-b831-ba7fd79cc1bc",
"company_id": "7f2fda85-55eb-43e8-a8d6-d912729bef13",
"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": "33a733da-f5fe-4624-8fbb-aee29efba695",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "9689b1e3-d805-4f12-b087-5c908c690d8f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "50b4ebda-10e6-4704-ab11-d41b5e0db954",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2e1aed5a-e416-483c-92fd-bd0f81e76836",
"company_code": "sample string 5",
"company": {
"id": "7acd1434-86fe-4ac4-bdb5-4814bf18ca0e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-02T07:15:00.0022802+00:00",
"sales_territory_id": "80497704-a76d-4369-9bec-b37352eacd90",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2d36cd4a-eab1-462f-a94a-bdf0f7b4d99a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "43508c45-c0ca-461c-8bd7-60654eb54f2a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a703ebf0-73c7-4680-b8db-1ca5328ec87d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94520a57-41fa-4f52-bbe1-5b6af171572b",
"db_currency_id": "4fc7b241-e3f3-4cee-a563-9025c29fbc83",
"db_language_id": "233ae8ca-8b02-4928-ba42-77c50322af99",
"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-04-02T07:15:00.0022802+00:00"
},
"modified_dateutc": "2025-04-02T07:15:00.0022802+00:00"
},
"marketing_segment_id": "4a3e24b3-f9c7-4bde-bf53-030193be1e15",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dd040376-e23a-4110-ae47-2d4663788b44",
"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": "285ffbe5-347a-4ef6-8bd8-9af7860b541a",
"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": "737a8edb-6a3a-43b0-8c80-86ec6ae290a1",
"db_country_code": "sample string 28",
"feelist_id": "59947384-f87c-464d-8399-eefff56b4d07",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1e2c7337-845d-435a-89fd-0e00ed3e47b2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6b0dc1af-e2a1-477b-b86c-11f47612999d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-02T07:15:00.0022802+00:00",
"db_currency_id": "78456bf5-6d3d-4164-85ed-dec17cb2c619",
"db_currency_code": "sample string 10"
},
"company_type_id": "5c93c093-95b6-4df2-8877-49736269ec05",
"company_type_name": "sample string 32",
"company_type": {
"id": "650c40f2-bf04-4d8f-b397-9e30c65e5c02",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "91c2ac88-9439-4320-8100-8642a953f3dd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d92fdd74-a5f2-41d6-84cb-c70ebd5f22fa",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2a512f7e-86fd-497d-8066-10f9abd39ee7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "58713c1d-c811-4507-8bf1-8a81e301a966",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6cea3872-7d8f-4e8e-aeb4-1f0ad8ac0cd0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-02T07:15:00.0022802+00:00"
},
"company_sector_id": "a2e54c9e-57a5-4ab2-acae-fc3e8ba4ea0a",
"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": "5bc8226a-6d60-4382-a7fa-7eaa55b4e94c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fbe7bcb5-f046-4812-8c8c-45e80d75d01e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "da354e76-a07b-479b-b488-cc1e0cdd41f6",
"account_manager_user_code": "sample string 56",
"company_status_id": "ce1e67b9-2b6e-49d2-91be-d7c7aa3f32b6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-02T07:15:00.0022802+00:00",
"id2": 60
},
"db_language_id": "fba6d03d-bc29-4e73-a9a9-7cf569eeacfe",
"db_language_code": "sample string 7",
"db_title_id": "dfbe6386-e337-4b54-9d3d-4e5599e8faf1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-02T07:15:00.0022802+00:00",
"create_date": "2025-04-02T07:15:00.0022802+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-04-02T07:15:00.0022802+00:00"
},
"modified_dateutc": "2025-04-02T07:15:00.0022802+00:00",
"id2": 22
}