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": "1d0e0230-b1b3-408e-a3ad-640c4d9febe8",
"_parent_id": "1bd15f75-655f-4173-9d15-3cb7c4715513",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "43ad347e-58db-4220-9b00-1beab381cbe0",
"company_id": "e5a78575-a3b6-4c8d-bd2a-1574291e788f",
"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": "7940932a-0983-4303-9286-29a012bc1008",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "8b978473-1bb3-4e69-9571-d5b935fd1822",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6c315a53-9400-4e16-992d-9695c7e4fb5f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "842e1908-37eb-43b5-816f-9b42af809930",
"company_code": "sample string 5",
"company": {
"id": "067d9343-0aaa-447d-b60c-82f72be47204",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-11T00:39:05.9566008+00:00",
"sales_territory_id": "734d74e1-b718-4ea9-955a-f1e87f4542f5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "71235778-7bd1-4217-8337-f41ee3505bcd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "61f515e8-11ab-4c63-8a9d-b09374d8fbcb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "482d7347-9e24-422e-80c1-795cecb1caea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "33647aaa-2a3c-464d-8a28-368301597365",
"db_currency_id": "30f0307a-e29b-4cd6-8f32-c6df0262dfca",
"db_language_id": "72882933-5dda-45cd-b327-57587689077c",
"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-11T00:39:05.9566008+00:00"
},
"modified_dateutc": "2026-01-11T00:39:05.9566008+00:00"
},
"marketing_segment_id": "dedff4fc-dc27-4979-9ef0-d78b5107eb32",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9271c7eb-589e-4638-bdde-2d00c59ee36e",
"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": "f6d7738c-a4f0-4f53-b683-3a8e6e7076aa",
"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": "0f845f67-32dd-40a8-a822-501c2d005dab",
"db_country_code": "sample string 28",
"feelist_id": "d03ed336-ab3c-44c0-b8a3-237711494d00",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "758debe6-2824-4aeb-b06c-8c7e40e66a24",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "55bd6dd0-cdbe-447d-b03f-76d19c91f503",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-11T00:39:05.9566008+00:00",
"db_currency_id": "69a3460f-8443-4caa-8761-c16f3d4e38ee",
"db_currency_code": "sample string 10"
},
"company_type_id": "8478f4e6-8767-48f1-81ad-2386d9e7d740",
"company_type_name": "sample string 32",
"company_type": {
"id": "8ae89381-9019-4fcd-9bc4-277ce66da889",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cbf53e75-067f-44e7-aae9-69b4cec269cb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "06748f50-64ca-4263-9b4f-5b37adaa729e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3fe5ad22-3c96-458b-8a29-bb94f544a600",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "14c1749f-3487-4c70-a874-ceb5dd3a4a6b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "03d15df2-f846-405c-a505-c4bbb5e82457",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-11T00:39:05.9566008+00:00"
},
"company_sector_id": "2d5d4ba1-d27d-4333-b711-c61c82bad964",
"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": "3bf47272-555c-4b0c-b2b3-51a5eefac0c6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "eb521a7e-816c-4950-b8f1-3dc23ebea13a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "31e2b42b-0be1-447a-8ced-5a163e01dd71",
"account_manager_user_code": "sample string 56",
"company_status_id": "119a21b0-f497-40ee-834a-cff883105671",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-11T00:39:05.9566008+00:00",
"id2": 60
},
"db_language_id": "19b01190-988e-4fa0-ba55-1b9e3af19c94",
"db_language_code": "sample string 7",
"db_title_id": "f094bf36-1471-4654-ab08-67cbc3240859",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-11T00:39:05.9566008+00:00",
"create_date": "2026-01-11T00:39:05.9566008+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-11T00:39:05.9566008+00:00"
},
"modified_dateutc": "2026-01-11T00:39:05.9566008+00:00",
"id2": 22
}