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": "e06578eb-8b38-4d08-b6aa-3d87e1fdafc3",
"_parent_id": "5650bdc9-8ec1-4e5c-93d0-532fbcdcce85",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "46b19150-a806-44b5-9d51-737327a8d63e",
"company_id": "62cfa075-ccb2-4e09-a0a8-6f0a10611de8",
"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": "6edb46cb-7d88-4362-b564-bd6ee817ecf3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "537d2016-f1b5-4d48-b913-e7022e9a4d0f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3a256ea5-77f9-4652-b610-335057c59c90",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2d86a3fb-33b9-4ddf-8f70-1395cef13882",
"company_code": "sample string 5",
"company": {
"id": "17ed61e7-f726-4456-8156-c79a1f3e50d7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-04T13:06:32.7940872+00:00",
"sales_territory_id": "55099c10-e874-459f-a799-97b584daec79",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6c83a8cd-3577-4b7b-b3e6-5ecb9621fd33",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "596a1d31-b2fd-4d6a-84e4-ec54ace6b929",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dc3aa050-c365-4bdf-817c-56d865c03ed4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4dad8b9-07af-4d8f-a627-70d2fa63d902",
"db_currency_id": "c2bc1441-b7a5-4b08-8d4b-9551ef23060d",
"db_language_id": "d1c293ed-7acf-42a7-bd8c-8216773b37bc",
"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-04T13:06:32.7940872+00:00"
},
"modified_dateutc": "2026-07-04T13:06:32.7940872+00:00"
},
"marketing_segment_id": "62207964-bd71-4c77-ab70-1d0a395a03c8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bda37a0e-d926-4447-b47e-0b2e36103148",
"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": "0f06426f-f333-439c-ad7b-9a1a9a231b0a",
"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": "1dbb9991-6bba-4eeb-9dd6-cba3b8b160b6",
"db_country_code": "sample string 28",
"feelist_id": "935d6521-8672-414b-b489-b63f64ea92ee",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3f35b700-2f55-4766-ba85-9070aec18ec6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "262d5277-e139-4ffa-8822-130fb9114caf",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-04T13:06:32.7940872+00:00",
"db_currency_id": "7e9bd4be-abf4-479d-bc2a-7cdf6cb0729a",
"db_currency_code": "sample string 10"
},
"company_type_id": "ef4a6174-6d75-4f9f-83bd-67bc9dd8ec46",
"company_type_name": "sample string 32",
"company_type": {
"id": "c0b596af-b705-46b5-90d7-c109df8a0c03",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e266dfaf-c556-404b-a40e-4d902b47dfbc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d2962059-f7f7-482b-8e45-1d9bbcf66a62",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b17357d7-9d89-4a45-ac72-69cd5953472c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ebcd91eb-b0ad-42b9-99e5-7492ebbbe2a7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b9873259-37cb-4a23-be27-75743107ffcc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-04T13:06:32.7940872+00:00"
},
"company_sector_id": "62dbb742-ddf2-4189-94a9-670942647b01",
"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": "bf77f14a-126f-416b-82be-6ff5453786d3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9cc98ade-e13c-434e-80c8-64fe102c0985",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2f60f7cb-41f9-4028-b8c6-97c5b913f770",
"account_manager_user_code": "sample string 56",
"company_status_id": "7417446d-72d0-4b60-bb69-a230acc37843",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-04T13:06:32.7940872+00:00",
"id2": 60
},
"db_language_id": "e7a27cf1-cf92-416e-bc35-38931e4e2188",
"db_language_code": "sample string 7",
"db_title_id": "fdbbeb23-27e2-408c-ad95-88b5c10a0b0a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-04T13:06:32.7940872+00:00",
"create_date": "2026-07-04T13:06:32.7940872+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-04T13:06:32.7940872+00:00"
},
"modified_dateutc": "2026-07-04T13:06:32.7940872+00:00",
"id2": 22
}