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": "0a24c4f2-574d-408e-ab69-81b133d05365",
"_parent_id": "024e8c9a-4ee9-4752-97bf-2466146ce3f4",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f28e6789-5df2-4bc2-985e-6fe27f409e98",
"company_id": "4a039fe6-2d3a-4072-9513-df52aff0a8f5",
"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": "c0f9de38-6ea6-4fbc-b91e-14a59f30b6c1",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a0162689-a58a-4491-a5f1-aae534678f10",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "b92a35ef-f7ba-4837-bc1c-8862a0a4198d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6c0fd787-8196-43c1-b627-86ee543ded27",
"company_code": "sample string 5",
"company": {
"id": "1faf125c-2781-4ee4-a586-e8074d31162e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-24T21:11:23.6130634+00:00",
"sales_territory_id": "2e126bc6-3693-411b-8762-e5c88745c548",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f5374a9f-7b06-487d-aba9-15c5fc766ff7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e859f7da-4e67-4f9f-b95f-b22f481b492e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ad4e88a2-67de-4167-aafd-d7c0d004ec55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a57a3171-d2c8-4843-985a-1dc568475449",
"db_currency_id": "a0edc11f-ae0f-4a5c-94e4-85f12f18e5b5",
"db_language_id": "78de979a-7666-400f-86ee-24af3499ff8d",
"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-24T21:11:23.6130634+00:00"
},
"modified_dateutc": "2026-09-24T21:11:23.6130634+00:00"
},
"marketing_segment_id": "5bf50954-30f1-400e-8579-689dfad55e74",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b4018a44-823c-446c-a48b-87d66ac4f14a",
"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": "9eb9e03b-895d-4361-96bf-a647f3567ed2",
"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": "045afe61-3f80-447d-994e-b66a0701feed",
"db_country_code": "sample string 28",
"feelist_id": "e48236c2-73d4-44f3-9701-bd3ba2920f09",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b3abb8d3-20cb-4e8b-9455-9c6d387d751b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "54e00777-5dd3-4f8c-9dd8-16fc7ada1ce7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-24T21:11:23.6130634+00:00",
"db_currency_id": "b70c6d5d-d48c-4a5f-8586-3b9533dfa880",
"db_currency_code": "sample string 10"
},
"company_type_id": "605aa949-851c-4bca-b91e-3bdedff8ebb0",
"company_type_name": "sample string 32",
"company_type": {
"id": "760eda86-41a4-4d9c-9fa8-e7456040b869",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a9646032-d996-4762-9ada-ce4dfd01ec6e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c35a7698-45fd-4e2a-816c-29b751588892",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "420a6dfa-33bb-4274-b73d-6a2ea2290e7f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2d938954-4c32-43aa-815c-fed4484a107d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "cd8ec651-6e14-45cf-a3df-46ecc7406a4f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-24T21:11:23.6130634+00:00"
},
"company_sector_id": "5930f794-7d17-4677-8789-a4e79c77788a",
"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": "014864a8-4f8f-4ae1-8aa6-9a787abc0c21",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ba168bb3-6c42-4075-b466-04409fb22479",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "54821bf8-933e-4052-b418-7f95d11cb834",
"account_manager_user_code": "sample string 56",
"company_status_id": "6e9a8661-7b30-4578-80e2-485e6fad9d71",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-24T21:11:23.6130634+00:00",
"id2": 60
},
"db_language_id": "34dedca1-5c92-4a72-8070-ccce6cd015c1",
"db_language_code": "sample string 7",
"db_title_id": "6a5591d7-2ba5-4eaf-8e43-4af3c119a1ea",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-24T21:11:23.6130634+00:00",
"create_date": "2026-09-24T21:11:23.6130634+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-24T21:11:23.6130634+00:00"
},
"modified_dateutc": "2026-09-24T21:11:23.6130634+00:00",
"id2": 22
}