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": "9f7c9c04-cc92-4bd0-8d1d-aca15b378f12",
"_parent_id": "d1de7686-b411-4f39-92d6-e413a52cb0b5",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "03ad7265-19f2-4f11-8868-abc4a2a17127",
"company_id": "c9460584-9e96-4c24-bb39-7dd5cc95ef8b",
"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": "2181a4df-6f04-4395-a7ec-448ccc758cbb",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "dd704c6a-6192-42e6-8207-863cb39939c6",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ca8a824a-5985-4855-982c-41febad737d0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8d9cc83c-7433-42fd-9125-c85dc15cf643",
"company_code": "sample string 5",
"company": {
"id": "bd2adf2b-0015-4966-a882-0f1ce632e8f2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-28T01:22:47.7833277+00:00",
"sales_territory_id": "8fe1487f-6749-4e60-a695-243672c1d5d1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6869d038-53d9-4b5b-886c-1eb8eae3270b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1489e132-4577-428e-aa95-f9c532eacc01",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3cc699bc-9b64-4890-a87d-476b7a36ef2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "168735bf-3d10-405b-84a1-d998a67de80e",
"db_currency_id": "d2a38323-b117-4fe2-8aad-c77185fc756a",
"db_language_id": "056ba05c-9414-4803-9177-12fe6d3bced9",
"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-05-28T01:22:47.7833277+00:00"
},
"modified_dateutc": "2025-05-28T01:22:47.7833277+00:00"
},
"marketing_segment_id": "5cdebb71-8a54-418d-834a-7786b0543010",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1cf3a58b-554e-40df-a614-84f92f5eb762",
"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": "7b6d255b-8099-48cf-9865-d7ee95f05b33",
"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": "69569c90-c171-4e4f-b980-db7ccbc0d89b",
"db_country_code": "sample string 28",
"feelist_id": "db577dcd-7a33-4116-baf3-f8dbfdda04f5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e9430207-ee9b-4675-bba8-18f19ec61c3c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7712027d-df74-4b35-a7e7-12b273eb164c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-28T01:22:47.7833277+00:00",
"db_currency_id": "1c15168e-3309-4a30-b2da-8843764f43bd",
"db_currency_code": "sample string 10"
},
"company_type_id": "315d0d75-2483-4dd4-a37f-3bab905be248",
"company_type_name": "sample string 32",
"company_type": {
"id": "e8087cc2-890f-47aa-9a85-2f9dfa22f564",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8b5785a7-0e77-4ad4-9c20-3807d7d98c0f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9393fd31-a3fc-46df-8f0d-b3f1f2a92e96",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7583d488-3670-4f2b-8f9a-4075be2bc690",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e3670d38-6c93-4906-b19a-9bec61cc25f3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fdeecb69-0b62-4f79-9d7e-1d22134b1a51",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-28T01:22:47.7833277+00:00"
},
"company_sector_id": "b3d80e00-d495-47cb-a31a-6e698229aff5",
"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": "f1ae5e08-eb30-48ba-bfc0-f8b04440b4e0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a1670035-de94-4d8c-ae40-26b1a59eabcd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c246bb41-0590-4974-87c4-83b000979893",
"account_manager_user_code": "sample string 56",
"company_status_id": "988318eb-faa8-4a4e-bf39-3bd2f7c0259c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-28T01:22:47.7833277+00:00",
"id2": 60
},
"db_language_id": "b49db7c5-74f5-4ee8-bded-cee4f686c78d",
"db_language_code": "sample string 7",
"db_title_id": "6e83e9f9-7ca9-4c41-a72b-11d1aecffded",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-28T01:22:47.7833277+00:00",
"create_date": "2025-05-28T01:22:47.7833277+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-05-28T01:22:47.7833277+00:00"
},
"modified_dateutc": "2025-05-28T01:22:47.7833277+00:00",
"id2": 22
}