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": "0a945da4-add6-4211-8eee-d3344cd1a05e",
"_parent_id": "f57835ae-aeb9-47f8-a956-3bd20028ee52",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "adf90e19-66ba-4728-abde-e9eca1660455",
"company_id": "fd8abc3d-bc95-4326-9bcf-8a22b1925618",
"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": "22f5408e-a2de-4435-bc1e-ae39485ddebe",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "7c4522a8-b435-4eac-8e34-11fcd89244eb",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "af52d072-ac95-46ac-b6bf-944b2f48bf8c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0f9294d3-022e-4eb6-89a0-581585206844",
"company_code": "sample string 5",
"company": {
"id": "a1935dd3-8509-445c-a200-6fd1aa8bed80",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-15T09:31:37.6692561+00:00",
"sales_territory_id": "09940ae7-11fd-4379-85a7-586c9740296a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "237d3f31-9909-4452-80bc-f3c00681ae40",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1b3ee3e7-57e0-45e2-bd0a-0830ea567a2d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c9885531-f892-4edf-a885-2b4e3eedb298",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52356f0c-f5c4-472e-b1d4-e5ac579fe3da",
"db_currency_id": "9dacf097-b123-490d-8ca9-ac2116ecc4d6",
"db_language_id": "f6a4d9f0-0948-475c-852f-65de19bc8efb",
"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-15T09:31:37.6692561+00:00"
},
"modified_dateutc": "2026-09-15T09:31:37.6692561+00:00"
},
"marketing_segment_id": "e4309e1a-fccd-48c1-be4b-684b8182dadc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b099c6c8-3b64-44ac-8c80-8483658c1f45",
"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": "333ca04d-5cf3-4c62-a1d0-87f4c0ef0156",
"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": "20b71ce8-f154-4ac8-a418-2065a308641b",
"db_country_code": "sample string 28",
"feelist_id": "f47283a8-70a1-4a32-9412-f5d2d7af4a45",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4349b0d5-334f-4b0c-8853-f74d392c6aad",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c39473ed-7451-4f27-863e-de5cc50aa6b6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-15T09:31:37.6692561+00:00",
"db_currency_id": "f78f2381-1e79-4b4f-abf7-a9003341f185",
"db_currency_code": "sample string 10"
},
"company_type_id": "776b1259-5389-4357-89bb-177ca5b7a3bf",
"company_type_name": "sample string 32",
"company_type": {
"id": "6d7c183b-82b4-47c1-9331-824e2488a14f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "68f1d002-6bf5-407d-8f8f-fb2d29ae9eec",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c8742635-3184-49a1-b9eb-6702a16a1e7b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "91e371d6-2955-45a7-b55a-43a3df3fe97b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5e01dfa3-4495-401f-8b39-0a5ec757b412",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bc61ed4d-b896-425d-aaff-45096bc112e3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-15T09:31:37.6692561+00:00"
},
"company_sector_id": "e52bcc38-43db-400f-a509-7ca60c4bcbd9",
"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": "338150f1-4383-48b5-ada4-54a02d885e89",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "08efcc96-9be7-4c4d-ada1-717fa997972e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8c318fca-d2f6-4fd7-944d-69e7f61b0646",
"account_manager_user_code": "sample string 56",
"company_status_id": "cc03af05-eea8-436e-94b7-27763278d748",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-15T09:31:37.6692561+00:00",
"id2": 60
},
"db_language_id": "738c9bb8-7996-474c-b6ee-5a94bb7153e3",
"db_language_code": "sample string 7",
"db_title_id": "0e91baad-071e-4771-a043-b974e42f8649",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-15T09:31:37.6692561+00:00",
"create_date": "2026-09-15T09:31:37.6692561+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-15T09:31:37.6692561+00:00"
},
"modified_dateutc": "2026-09-15T09:31:37.6692561+00:00",
"id2": 22
}