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": "68ecda82-3de4-474d-b063-397856bf77e8",
"_parent_id": "cdcd18b9-ee6d-4b9d-a0c5-0d9e9e52bc11",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ba830c49-072a-4dec-859c-5aeb5b85eb32",
"company_id": "07fc7006-a2f3-4132-9f3d-5e5c31b0db89",
"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": "f6497ee3-42b6-4958-8187-c98627afa721",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d18ecf19-f3b4-42d5-9d0f-8db29410ec46",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "1e3e1d86-5d86-4492-bd07-ca20f8a2db97",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fa60d58f-4e0c-479b-968c-c7ec22c38f52",
"company_code": "sample string 5",
"company": {
"id": "00d07bf4-c056-4240-95f7-3b8c17b73ce3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-04T02:56:02.346999+00:00",
"sales_territory_id": "5839e391-4603-48f3-9307-f99089f6bac0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0e410355-ac17-4605-be7d-dfeedc0e4b49",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "79a0c70a-8fdb-4921-acd8-34113765ccf4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "12dce2d9-1cfa-485f-af31-62627cb3aa58",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e19b06dd-19a8-4d1d-ad19-507a7a56bf3b",
"db_currency_id": "0fa3bdc6-147f-4938-9bf6-a94bfb34b70a",
"db_language_id": "137110c3-a462-4be5-b6e5-5204b48f198a",
"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-09-04T02:56:02.346999+00:00"
},
"modified_dateutc": "2026-09-04T02:56:02.346999+00:00"
},
"marketing_segment_id": "173ca936-4f3b-4c81-bac1-c438647487be",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c063c48d-fdc0-40f1-bb4c-ef5a68344acd",
"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": "e35b1991-6cd5-414c-a943-23ebf109991f",
"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": "8ac7d9d8-b9d4-48b8-9f48-955b804ceb2a",
"db_country_code": "sample string 28",
"feelist_id": "8cd25b44-7ebd-4282-b182-e5fcf1198be4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8292e92e-1e02-4196-97a2-3d0286346730",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0af98102-7115-4c6b-82f2-ce2002d09a62",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-04T02:56:02.346999+00:00",
"db_currency_id": "1eebd95b-d300-4f8c-aa3e-83318200f0ff",
"db_currency_code": "sample string 10"
},
"company_type_id": "2c48ea54-f355-4193-894c-277cb5c329f1",
"company_type_name": "sample string 32",
"company_type": {
"id": "9cef6735-6f6c-4cea-af90-6ded6c9feeeb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fd1673fe-87ad-4f0c-a598-ffce7fa1cb34",
"sales_organization_code": "sample string 5"
},
"db_language_id": "73e2704f-e4e0-4453-95d2-815694c52786",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a6925bff-b471-4b87-9c04-b96fcf153993",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cba97722-98f8-4d0d-b59b-482572af86c9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f6253ae4-7e67-459b-b9dd-2e77d248ef32",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-04T02:56:02.346999+00:00"
},
"company_sector_id": "f3b8e2ff-0eb1-472a-b6fc-dd6e367f2d94",
"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": "d1150f19-08c6-4829-96f2-4a72663de4c5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a176e4ac-52de-4dd9-ba21-613bd8a33107",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "300c5446-d637-43ec-8560-df37d0e55a0b",
"account_manager_user_code": "sample string 56",
"company_status_id": "01cd2bd4-0099-47dd-ad57-3da966728d58",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-04T02:56:02.346999+00:00",
"id2": 60
},
"db_language_id": "4cc6034d-889a-4b3e-b622-6467af220eba",
"db_language_code": "sample string 7",
"db_title_id": "80ee0f35-d80d-44c6-b4d7-ba789c4a5274",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-04T02:56:02.346999+00:00",
"create_date": "2026-09-04T02:56:02.346999+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-09-04T02:56:02.346999+00:00"
},
"modified_dateutc": "2026-09-04T02:56:02.346999+00:00",
"id2": 22
}