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": "37f9c010-e6e0-4e9c-bb0d-6673a3347f5f",
"_parent_id": "0d905727-a195-4a6d-bbb0-7ea77a3c615b",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ae7b7b8f-2a33-45c3-97b3-c9524f0d43e3",
"company_id": "66f064f9-c7a3-4fd4-8d53-25182a533cbe",
"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": "fbd7f825-538f-4d52-801d-c013e0211a4d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "032f1f5b-dcf4-4124-9154-8584679ddc86",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "57c20a9f-ec1d-44d3-bae4-845df0410ea1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4b18d310-bcb8-4ded-8a3e-4dc462a4ea65",
"company_code": "sample string 5",
"company": {
"id": "589d4e51-ac5b-4b62-92f1-a55d0bbab906",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-01T05:34:10.5998823+00:00",
"sales_territory_id": "b6effdcb-f3c8-4fc6-b3cb-4c41d0674332",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "67aea87e-f626-45e2-8e4e-b2f50b46d765",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6268c319-81ea-448f-a4c8-b35dbc55def1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b534ee3f-b031-4bc8-8cb1-0ca6497cc517",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "455fc74b-7d31-469e-a890-e7fec9a263fb",
"db_currency_id": "305ab8cf-5134-40fc-a3b5-a4ea3f51c4ab",
"db_language_id": "2a43fb23-e187-4d3c-a226-141b2f55e382",
"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-05-01T05:34:10.5998823+00:00"
},
"modified_dateutc": "2026-05-01T05:34:10.5998823+00:00"
},
"marketing_segment_id": "66cff1d1-3899-407b-a892-15ec68ddc2e2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b9ef57ae-f4b7-477a-8db4-34a081089d1d",
"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": "26b41657-2753-41e7-bb8f-a4925cbc67fa",
"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": "612b1bf0-2fbb-4fea-9d53-fe0662a9423c",
"db_country_code": "sample string 28",
"feelist_id": "172448b9-c0d3-4dbe-8243-20f5d2502b21",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3a8444c7-66a0-4e6a-bba7-5d05bfaeea8a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1d2e266e-8a64-456f-a370-6ff048041a64",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-01T05:34:10.5998823+00:00",
"db_currency_id": "18eb930e-b8d2-4abd-b4c5-969bc3f8f254",
"db_currency_code": "sample string 10"
},
"company_type_id": "f65590aa-0551-437c-a513-7c4c5ae80c5c",
"company_type_name": "sample string 32",
"company_type": {
"id": "5f8ec83a-82e1-4b7d-ac35-22965df88e53",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "26bafba7-c19a-4e56-88b8-f48c17297c1b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8fa4c202-3bfb-4cb4-b144-9c4dc814dcb8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5b60daed-3b14-40e2-a72f-484fefc24fb3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0920ce58-eb32-4c34-b42b-e9c49e2144f5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6ec7bad6-3454-4d5e-acc0-58caf4662a07",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-01T05:34:10.6155113+00:00"
},
"company_sector_id": "f56940d5-b39c-4367-add3-64d85b95e4bb",
"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": "3854cb13-116e-452d-9d3e-6b9bdeb89247",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a7762f48-9941-46da-9926-d9418e861e69",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "07d2ee17-a93e-4637-a3e7-6788170550f8",
"account_manager_user_code": "sample string 56",
"company_status_id": "ed203083-9f4a-4873-80b3-069ce2ef2837",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-01T05:34:10.6155113+00:00",
"id2": 60
},
"db_language_id": "a2e22854-10ea-4d28-b529-5d013f63a59f",
"db_language_code": "sample string 7",
"db_title_id": "af4cd917-ac3d-428e-92a5-a65dc32944b8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-01T05:34:10.6155113+00:00",
"create_date": "2026-05-01T05:34:10.6155113+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-05-01T05:34:10.6155113+00:00"
},
"modified_dateutc": "2026-05-01T05:34:10.6155113+00:00",
"id2": 22
}