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": "8a2c222a-5085-4ec1-a700-3068e33a543a",
"_parent_id": "35f228d4-4eeb-4a99-a172-f9286c0e5a3e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f9576ca2-ca4b-4c0c-89c6-f8338e41785f",
"company_id": "539cc008-998d-438f-938f-5eacb2274a4d",
"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": "53d2c4ff-3fc5-48cd-8a42-dc92491c1817",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "823993bb-13ce-49ec-8569-6f96d2bb80e4",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "82f453b6-61f6-4939-bc3e-485ff7149079",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ac83e33b-b5cb-4de1-816f-34995caa0656",
"company_code": "sample string 5",
"company": {
"id": "930ffc0a-8cba-4992-8794-dbee62862519",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-31T21:27:55.7384312+00:00",
"sales_territory_id": "33797df0-f924-492d-9be7-35a6cb770f3c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2fb35319-8977-4dcd-a7ed-6b06ed7d5933",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5de00c1f-b6a8-450a-ad67-3122f4509e7c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "982e74ad-b8d2-4a5d-b217-dda29d29f80d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9535425c-2441-44a5-8cd2-d1ecae47f89b",
"db_currency_id": "005a388b-fc77-405f-a9d1-1ff21ed39914",
"db_language_id": "ceacc2cb-aab8-431f-b2aa-ae7a99c1d420",
"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-03-31T21:27:55.7384312+00:00"
},
"modified_dateutc": "2025-03-31T21:27:55.7384312+00:00"
},
"marketing_segment_id": "cab19928-bae2-449d-a82f-1a199070edc1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "73943996-d5a5-4b62-a4b8-f4e17f37c5f9",
"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": "894ebd88-a28d-4fc8-af56-83f18c83043c",
"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": "2026cb7d-35ce-438c-8d56-4744b9d3aaa9",
"db_country_code": "sample string 28",
"feelist_id": "ddde851b-72c6-43b4-b46e-4b760dd13621",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6512db7f-ea73-490e-8097-2a6d1f6a42d8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a5ccaf2b-100d-47b5-866a-5569d888070f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-31T21:27:55.7384312+00:00",
"db_currency_id": "6ce817d4-118d-4550-9629-7333ebbf8960",
"db_currency_code": "sample string 10"
},
"company_type_id": "f306b99b-c2ab-4df9-97c2-d0b0058a3c51",
"company_type_name": "sample string 32",
"company_type": {
"id": "8ac2e69b-83b0-4f31-bb17-41bd2c2f049f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c72fe6bf-eeaa-45fe-baad-855bb83711f0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1d434185-3276-4608-9a2b-d0649ef240e1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "622ac92a-5558-47c2-879a-54b366349a73",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e46274b7-e292-4679-94bd-76a365a82cc5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "52fbe083-6048-40c4-9a80-f8b38e89b3dc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-31T21:27:55.7384312+00:00"
},
"company_sector_id": "3527855f-28e7-46e2-9801-f18666715127",
"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": "a198bed8-e20e-4f31-8833-544ee3970ee7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2a06233f-97b9-4dc3-ac7d-0d68a9d6a04f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b33a8520-6ef2-4dfe-bc98-2818f628a8ec",
"account_manager_user_code": "sample string 56",
"company_status_id": "b442a7b9-5f26-488b-8a1b-e8c891d288db",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-31T21:27:55.7384312+00:00",
"id2": 60
},
"db_language_id": "b6d008f1-1186-4a09-8131-45655bcca702",
"db_language_code": "sample string 7",
"db_title_id": "45159d33-d840-4227-b85c-a79e1b9c636a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-31T21:27:55.7384312+00:00",
"create_date": "2025-03-31T21:27:55.7384312+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-03-31T21:27:55.7384312+00:00"
},
"modified_dateutc": "2025-03-31T21:27:55.7384312+00:00",
"id2": 22
}