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": "e0bd0b37-8212-4a4e-a7a2-9e4115560874",
"_parent_id": "83f207a0-d6d4-49d1-a056-b20702aa03cf",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "3255c230-88b2-493f-bb07-f17d6321997b",
"company_id": "9fea695b-0a6a-4ffb-9d8b-917fb8d1d78a",
"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": "d0143c52-75be-4712-b6ab-871f6a8bab86",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "5d3dfcc3-2117-4f55-83fa-d2accbbe7b97",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a51d1982-1f0d-4a70-9d8f-4ad73b76750f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6e9b1819-6ef6-44ac-bb1e-f1feca5bae74",
"company_code": "sample string 5",
"company": {
"id": "dd63ebda-9338-46db-8404-c2dcde268a85",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-18T00:59:02.1993368+00:00",
"sales_territory_id": "5012ce61-af24-43e8-b3f5-3012526e4ae5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c1c065bb-c8a7-48a9-a4fe-1579485dab84",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d2f26a4c-12ef-4b31-9ff7-c8221cea972f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "305c5342-e9b2-4f06-97fc-f3d6a2b53fac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eb1c95c-c27f-4c0e-b04d-e0f4bd02a9c6",
"db_currency_id": "810928fb-3653-4e4f-918f-0abb4a689385",
"db_language_id": "0086a6fb-a96b-4a2d-9bce-536555f94d71",
"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-01-18T00:59:02.2149697+00:00"
},
"modified_dateutc": "2026-01-18T00:59:02.2149697+00:00"
},
"marketing_segment_id": "f0e17980-7d8f-4d8f-81fc-264ac5c4b88d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "69205604-e2ac-4484-adae-1c1ad3e87edc",
"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": "ba10e73c-bcb0-433a-aca3-e19d95936ab7",
"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": "6d71dc54-1e71-4209-b913-0ea57d962b35",
"db_country_code": "sample string 28",
"feelist_id": "f3830566-5f2f-4173-9d1d-39d597ada539",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "71f1f59d-b0db-4a0a-af88-af6760291a55",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5c478229-1a33-427d-a63a-dae2de98ca02",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-18T00:59:02.2149697+00:00",
"db_currency_id": "405d47c1-183a-46c3-884f-a291a58f5472",
"db_currency_code": "sample string 10"
},
"company_type_id": "fe1467aa-a4b6-4d52-8eeb-b83f9bb11fd1",
"company_type_name": "sample string 32",
"company_type": {
"id": "3b94135d-3b97-4e32-804b-02aa12594f56",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5aa8962c-7334-4133-a0f2-836e3911014c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d0c3321e-0fdd-477d-a7a0-3831fdcb66ea",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "877a1a71-99e7-41b1-b6a5-c648e10449b7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f2e0b3c7-26b3-4da3-a3b9-365881744ac6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "63b7fb10-fb24-4084-bb2c-ea8ca4d70eaa",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-18T00:59:02.2149697+00:00"
},
"company_sector_id": "5d0bbea6-7cfa-40d8-9d6d-26941eda8446",
"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": "73e95eff-ca0c-4fa5-a8e3-bb6bb3c54c13",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d2ef8190-ed2e-4db6-b4f9-433ee6149ff6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fac1c814-5ba4-49a1-baac-03f055ac6b86",
"account_manager_user_code": "sample string 56",
"company_status_id": "130e130e-398e-492b-8d88-9bfa89953a05",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-18T00:59:02.2149697+00:00",
"id2": 60
},
"db_language_id": "d64843e7-815d-4cfd-8ff1-357e22bf20ea",
"db_language_code": "sample string 7",
"db_title_id": "c3dc8dc8-f6cc-4e89-83d3-56e1ab1a8372",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-18T00:59:02.2149697+00:00",
"create_date": "2026-01-18T00:59:02.2149697+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-01-18T00:59:02.2149697+00:00"
},
"modified_dateutc": "2026-01-18T00:59:02.2149697+00:00",
"id2": 22
}