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": "cea0b2e6-8baf-455f-a946-726f9e338587",
"_parent_id": "68e03fdd-4e9c-4763-a777-35fa02a403aa",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "4d244826-e4d3-4462-a75a-3fea22e4dde3",
"company_id": "4e6b4b24-5d78-499e-bc8d-a626e0dedf0d",
"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": "0293695f-4052-478e-b0a2-e749f96faeae",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "95be36a6-e847-42aa-a45a-122d363c763d",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "eb3eb0ef-a37d-419a-9fcc-30fe205f603c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "27ad4c21-7075-4dd7-a680-c68188bfda94",
"company_code": "sample string 5",
"company": {
"id": "eecda93b-7a23-40be-a88e-907ebc23738d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-22T21:04:07.9395435+00:00",
"sales_territory_id": "ef43bf03-a127-4b7c-b6ab-404c38148492",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0b2e7ddf-8ff5-40f7-abb8-cf766d1d27df",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3f854265-b881-49d8-8038-125b4b54ca4a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "219b9b3a-ba8c-4ace-9a8c-cdde5772d910",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "659df450-e8f1-48b2-a20e-ffd9a5b5dd73",
"db_currency_id": "d9b8c4d1-696e-4fee-993e-32f79c5f2101",
"db_language_id": "02c159a9-2e97-4289-9295-976544e724e3",
"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-08-22T21:04:07.9395435+00:00"
},
"modified_dateutc": "2026-08-22T21:04:07.9395435+00:00"
},
"marketing_segment_id": "8b024edb-bca7-44b1-accc-e213d65266ac",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9631a6a1-70d6-48c5-9314-c8d34a4e2cf8",
"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": "e0196c5c-b89d-445e-a23b-f0271a1fec75",
"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": "be542834-3514-4dca-975d-d30511918dae",
"db_country_code": "sample string 28",
"feelist_id": "1d751c4f-240e-4584-a28e-df82a19f3f33",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0a7263c4-2122-4d07-85d9-8134d2429aee",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "802f87cf-f204-41dd-a45d-4b5d6e880566",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-22T21:04:07.9395435+00:00",
"db_currency_id": "3851f004-cc28-4cbc-a308-acd3b7e0bb5f",
"db_currency_code": "sample string 10"
},
"company_type_id": "84814978-51d6-46dc-8988-4808769628d3",
"company_type_name": "sample string 32",
"company_type": {
"id": "86d570fe-8e87-4e92-9478-7dabd7ead56a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7666a8c5-34b5-4de6-be53-771ce8bf9136",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ad890de9-97f6-48a1-90a6-08d924fd73af",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2e888703-42cc-4856-8b2a-ee4cb4f8b916",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8a987044-6fd8-4a1c-8b0d-138d50f60b46",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "aa29a391-38cf-4393-8e2c-35290beac144",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-22T21:04:07.9395435+00:00"
},
"company_sector_id": "534851f1-6de2-499b-a7fe-f35b54c36999",
"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": "1e493c37-37aa-4594-bdc7-eeadd3f4348c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f956230f-bd90-4c91-a21d-067fdde21980",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7a82d656-3914-4378-943c-4ff892fb3244",
"account_manager_user_code": "sample string 56",
"company_status_id": "e7cae7cd-899c-4bff-9954-85b22142317d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-22T21:04:07.9395435+00:00",
"id2": 60
},
"db_language_id": "467e6a6f-98b0-4d47-96f8-7477d5997cdf",
"db_language_code": "sample string 7",
"db_title_id": "7227f74e-2c0d-4070-87e9-96fb29cbaae0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-22T21:04:07.9395435+00:00",
"create_date": "2026-08-22T21:04:07.9395435+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-08-22T21:04:07.9395435+00:00"
},
"modified_dateutc": "2026-08-22T21:04:07.9395435+00:00",
"id2": 22
}