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": "541c7e0d-fa2b-42cd-a70c-8cd62f8a5e1d",
"_parent_id": "280b9782-a31c-4f63-977c-4b1f0926072d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9b0fa1d5-97cc-42cb-aba3-05b31d26935c",
"company_id": "09f4ed53-5d2a-43d3-9ed6-0f4c854b9f0a",
"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": "10b2605a-9a1b-4cab-bbdf-6bca1038a1b8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f44feec4-6e1c-4655-9357-52ea56f9f22a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2259be66-0b2a-42b8-b953-02281deefd91",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d2e48cab-c4cf-44e9-8c9f-e3b3312d1091",
"company_code": "sample string 5",
"company": {
"id": "f638b160-93d1-40f3-901d-d8a1b929c559",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-10T21:38:49.0627926+00:00",
"sales_territory_id": "008b6774-2403-46b3-9a51-3c802e615637",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cab3dfd2-e935-4cb7-81c7-8cb829a5d315",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d326b8c1-94e2-404f-9581-8d2ca4de261c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4f9695ae-436b-4294-804c-f2319cb0c640",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3cea1a2-cfa5-4e18-9c16-e12c9325a703",
"db_currency_id": "09949981-96cc-4ab1-84c7-150e05e27bde",
"db_language_id": "a95e7716-bc0c-4149-ad11-3f006d543753",
"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-10-10T21:38:49.0627926+00:00"
},
"modified_dateutc": "2026-10-10T21:38:49.0627926+00:00"
},
"marketing_segment_id": "6534630d-7647-4eec-a8ce-24f489c33450",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "827cb350-ff29-41e3-b1d6-d68c4407c255",
"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": "e5ed7bae-02bc-4bcc-96ac-a39a8b726167",
"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": "0e27bfe0-5eb5-4c5f-b061-6b33f36c2b83",
"db_country_code": "sample string 28",
"feelist_id": "7389aa7c-3840-495f-bfc5-cdd9e5eae727",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7715cda8-f83c-4fde-a751-1e80133b7121",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dd318b5c-be30-465c-83e5-da54da3a16b3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-10T21:38:49.0627926+00:00",
"db_currency_id": "f2245356-f81a-45e0-a90e-ceca5392cf4a",
"db_currency_code": "sample string 10"
},
"company_type_id": "da89185f-3c70-4542-b899-70e90390a5bf",
"company_type_name": "sample string 32",
"company_type": {
"id": "6b81037d-742e-49b0-a099-1926b65b4220",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7c620fb0-b97b-4ece-a45e-48d963e40744",
"sales_organization_code": "sample string 5"
},
"db_language_id": "850546f4-6f51-4cc0-ad99-e71769b6ad68",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a2aa68d1-537e-4add-88b6-d6c972b4010d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2695ab35-6689-439f-9725-49cd61924eaf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8be02c62-637d-41b3-b4b5-15b96773fe71",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-10T21:38:49.0627926+00:00"
},
"company_sector_id": "be74ae22-1011-442f-992a-722c983ab3a1",
"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": "ac9a17ad-cfdb-417d-b2a5-5bdaa3eefb58",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f0e423e6-1729-48e2-8ab4-348cf8839b3b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "99b9d3e6-414c-4f3f-9d5e-79caec6a0df9",
"account_manager_user_code": "sample string 56",
"company_status_id": "8f4e3147-aa61-467f-9fa8-ada7b9705a39",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-10T21:38:49.0627926+00:00",
"id2": 60
},
"db_language_id": "08169d10-0618-4bb5-8739-a74eb1babaf4",
"db_language_code": "sample string 7",
"db_title_id": "aa5e430e-691b-4f06-85f1-fdbc92ef94ff",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-10T21:38:49.0627926+00:00",
"create_date": "2026-10-10T21:38:49.0627926+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-10-10T21:38:49.0627926+00:00"
},
"modified_dateutc": "2026-10-10T21:38:49.0627926+00:00",
"id2": 22
}