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": "8d4c8883-6202-4d86-8ffa-0a1594b3562c",
"_parent_id": "2ec5c0b2-a64a-4aff-b137-dc3ea7b2813a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "055d12ee-5e28-48e1-882b-d6398d5b8823",
"company_id": "073fed08-d09d-4d72-8c63-f49c8a530243",
"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": "f953af19-6705-4201-ac3a-e6bdd0dabb92",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "caed35d9-eb25-4181-b324-7e224ec5d35c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f7776006-41ba-4bde-8bbb-4a990d9dd5bf",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b4ec4cb0-8e44-47ce-8cf0-30f510f5a7b4",
"company_code": "sample string 5",
"company": {
"id": "b4bfb434-5725-4384-8767-9e0ccb11f719",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-30T14:45:38.0302266+00:00",
"sales_territory_id": "5b8892df-0ce9-4784-a4bb-45fc3d515d89",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3ed795ff-4e64-4bbd-bff0-f4fe911ddade",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5d049ec9-ec42-40c1-8ff1-7ae8e67cbb52",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e3b6b776-2980-4316-93c1-2b9dd969eb69",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd7bb716-a6be-4478-b335-ab153b4016e0",
"db_currency_id": "83013616-f3fb-439e-a645-f93073382a88",
"db_language_id": "cd4b4d17-0970-4705-a7f1-7b5918354fba",
"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-30T14:45:38.0302266+00:00"
},
"modified_dateutc": "2026-09-30T14:45:38.0302266+00:00"
},
"marketing_segment_id": "867861e2-60fe-472a-9121-182943a94e66",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7d80282c-fca1-48eb-9a55-b9096ae26875",
"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": "a6e46ddc-af65-475b-9888-44ddf58d998c",
"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": "4cf9243d-7fe9-4482-8266-56879cc43e6c",
"db_country_code": "sample string 28",
"feelist_id": "6ade7473-86bf-41ef-87fb-039e4b55a695",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e83fc7e5-97d2-4bda-b81b-94d4bd62be73",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "579b1042-0cc6-4728-8b9f-516b24039a8a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-30T14:45:38.0302266+00:00",
"db_currency_id": "8c72022f-d7b5-4f75-8170-fbb663d5fcc2",
"db_currency_code": "sample string 10"
},
"company_type_id": "7b02cd3e-2328-4c20-907a-26615ae0293e",
"company_type_name": "sample string 32",
"company_type": {
"id": "57a25a47-0584-429a-9d81-1a6e7f346898",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cad233b2-7382-4c8b-9932-e940ffc215d8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "14553f92-fd08-4c47-be8c-619ff6d2037f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "059dd8e3-6d10-4923-8fef-983313534bd7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "630b58e8-3ca2-441e-87ef-0ce717d7d966",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5b529e57-b9e6-4ba0-a0b3-d3ff2e6b71dd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-30T14:45:38.0302266+00:00"
},
"company_sector_id": "d4321a4c-72cb-47e8-953a-f1104c4bb3b5",
"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": "75883775-d71e-4223-8c4d-c0cd9b4d6198",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "97742c79-d491-414a-b1b1-d73ab4c29727",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "335963a1-8ff3-4518-8f8c-6f18c29dc1ea",
"account_manager_user_code": "sample string 56",
"company_status_id": "5b511d49-e912-4362-826f-c4f05075c40a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-30T14:45:38.0302266+00:00",
"id2": 60
},
"db_language_id": "9a094c75-d666-4d22-8d01-f57c9a3fe76a",
"db_language_code": "sample string 7",
"db_title_id": "51a08c6b-769a-4b04-927f-5c5015150577",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-30T14:45:38.0302266+00:00",
"create_date": "2026-09-30T14:45:38.0302266+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-30T14:45:38.0302266+00:00"
},
"modified_dateutc": "2026-09-30T14:45:38.0302266+00:00",
"id2": 22
}