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": "c86eb11c-3182-401e-bd30-ba856546056a",
"_parent_id": "f3659711-aeb1-472f-9b60-361a56b3ccc4",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "3242759e-c525-476e-9de4-e4f01989ef45",
"company_id": "59f21b6f-7949-481b-bacd-d6f835e30e6d",
"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": "9d3bbc22-53c4-4609-a0d1-744a601b3aef",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "39c772fd-71ef-4690-9d2c-e33e9423d6d3",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "1067f98b-b04b-48df-a816-4b99677ab80e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "466313b1-838e-406a-88e6-f9246d78766b",
"company_code": "sample string 5",
"company": {
"id": "94d7ac98-0ce9-4b0b-ab6a-b1d64ff226b5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-10T20:54:03.9880491+00:00",
"sales_territory_id": "633daa62-63c8-4651-b90c-0feb2cd68b20",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f080c0ba-03b7-4e40-8c4a-330e97fab5d4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "41f9a5ea-dbf3-41a4-bd76-536d42ab1978",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fef716a3-0142-41cc-b281-b3f4d072f8cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d1cb6ae-98bd-4dc0-8114-269d49a38929",
"db_currency_id": "b80fec99-4803-460d-aee6-aade512ad713",
"db_language_id": "7d7f180c-8ce9-420e-9ffc-4d248d1af3a0",
"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-07-10T20:54:03.9880491+00:00"
},
"modified_dateutc": "2025-07-10T20:54:03.9880491+00:00"
},
"marketing_segment_id": "2b5d98b9-0b30-41dc-8ff5-c947bb15dcc3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "655537d3-e33d-4b64-87f5-4e83f3a6e86a",
"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": "8707c157-477b-4c4c-bcf2-553b499828e7",
"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": "bc68475a-e282-43ca-8edf-3abed08ad911",
"db_country_code": "sample string 28",
"feelist_id": "6fa340af-9be3-4c2a-a6da-7e2aa5416d8f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "40b931f3-5a8d-4a26-b2f5-f5f86cc7be78",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1526abfb-74de-494f-a712-f812733cce85",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-10T20:54:03.9880491+00:00",
"db_currency_id": "d011ee2a-d95a-4d05-bf24-8f798a4a6f22",
"db_currency_code": "sample string 10"
},
"company_type_id": "5af97295-530c-4525-ae48-8d36962c955a",
"company_type_name": "sample string 32",
"company_type": {
"id": "9c54fdd6-660a-4970-b6b0-22c7416dbca5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "364a666d-a5dc-4598-b3c3-1d76ce2c822e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "691eb1ca-c488-4d8e-8e34-f8c731b59535",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "95c4ff3b-be31-440e-8d52-47584fb83a3b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "61270d8c-9468-4a31-96d9-b5d4cd4fb9d0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a4a393cb-30b1-4101-91be-ff734ee04d07",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-10T20:54:03.9880491+00:00"
},
"company_sector_id": "86a88fbf-297c-4cf7-b0d6-12492582a388",
"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": "0d9e8673-e091-4cc9-a24a-2640f7d8725e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2b7a1b47-be23-4c10-b780-956eb91e13a9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4adb89b9-bfda-4bb3-aceb-4b3529930b6c",
"account_manager_user_code": "sample string 56",
"company_status_id": "31cd10e3-168c-4e1b-a549-5f150aa86cdc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-10T20:54:03.9880491+00:00",
"id2": 60
},
"db_language_id": "699b456f-6584-4609-85a9-fb896eb15e67",
"db_language_code": "sample string 7",
"db_title_id": "a931f5c4-2688-4780-b40a-9eae5dc21464",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-10T20:54:03.9880491+00:00",
"create_date": "2025-07-10T20:54:03.9880491+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-07-10T20:54:03.9880491+00:00"
},
"modified_dateutc": "2025-07-10T20:54:03.9880491+00:00",
"id2": 22
}