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": "2929bc56-0b33-4651-a914-4f1500149a3b",
"_parent_id": "e41a7ea5-e046-468e-a6ef-3fd4001d6b97",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1e2d0684-a604-41ea-9d76-1b447449e388",
"company_id": "431d3435-d003-4dc5-a0ff-694b483e6336",
"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": "09900b04-5867-4a87-a8ca-0250c5374234",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d36910a7-ce74-45f9-af4f-7bc6dbcb4f62",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e6b006b3-d7ca-4464-a597-6539b5259729",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "beeefe01-a7d6-4507-bdac-89f3d0f74f2d",
"company_code": "sample string 5",
"company": {
"id": "ede5399f-1504-4466-ab8f-b1d97f7ad117",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-05T05:31:08.4601356+00:00",
"sales_territory_id": "247c83ce-d5e9-468f-8e3a-e6b5557c23e8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9028ddfc-9da7-4e48-8b30-51341ac0fd99",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cd88e63b-27b7-454d-9a2f-88cf193024cb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1d6ca43a-1475-493e-9ff1-fb2d7e733b74",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "120a6197-0699-4dcf-93e7-6d1547e7c330",
"db_currency_id": "526cbada-77e4-4f06-ae6c-5b7a374669a6",
"db_language_id": "4fa5b5d4-cf79-4e0f-a410-5e8306fe36e9",
"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-07-05T05:31:08.4601356+00:00"
},
"modified_dateutc": "2026-07-05T05:31:08.4601356+00:00"
},
"marketing_segment_id": "9346ced4-bd22-4396-9ba9-ee5d30a6c3b5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8cecc3a9-9f68-4cfb-ad82-62a7e99651ad",
"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": "2db472f9-9441-4494-84d6-6bb61043b5fe",
"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": "f7e439ff-7132-4a55-b94f-8a8d0d3db0ff",
"db_country_code": "sample string 28",
"feelist_id": "59b654ad-05d1-4231-9bad-0c207d6f0277",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2e81f786-4100-4ec7-90f8-199377c72311",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6aeda026-f472-4fc5-adcb-6cc4d76b11b8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-05T05:31:08.4601356+00:00",
"db_currency_id": "9707ece6-f9d1-4a0e-9532-788f8472aaa6",
"db_currency_code": "sample string 10"
},
"company_type_id": "f4d65f0c-6a1c-4902-b066-fb39a993ef08",
"company_type_name": "sample string 32",
"company_type": {
"id": "c6d47d60-5db7-4964-8eb2-808d72541c77",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a33b6964-d1e7-480a-8317-b9607083a74b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "24bfeb51-e3f3-4153-8ff8-54078a89b209",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "46e67311-34da-445a-a5b2-01bd990ce1d4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "85edbf4d-d5d3-4223-9e30-5a9d563e7f97",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "01400f9d-1af9-4bad-8bb9-a3e3e338304d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-05T05:31:08.475759+00:00"
},
"company_sector_id": "faefd279-31e0-4bd0-9a6d-1b8ccfc600b4",
"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": "d007bf3c-ba87-415b-bbb8-725164b914be",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1261e343-a337-4ca3-b2a8-c3f88eb39577",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "93e0396f-8efe-4474-9d8c-f6c3ea8d4980",
"account_manager_user_code": "sample string 56",
"company_status_id": "588cbb1d-9237-4a3e-a15c-97d9997b6e76",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-05T05:31:08.475759+00:00",
"id2": 60
},
"db_language_id": "dee513a5-8715-4acc-b268-2c77d125d95a",
"db_language_code": "sample string 7",
"db_title_id": "723d84a5-319c-435e-b086-f0891b097cca",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-05T05:31:08.475759+00:00",
"create_date": "2026-07-05T05:31:08.475759+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-07-05T05:31:08.475759+00:00"
},
"modified_dateutc": "2026-07-05T05:31:08.475759+00:00",
"id2": 22
}