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": "ed2cbff4-41ad-4c09-93ba-1d19c5dbb52e",
"_parent_id": "d39a383b-abad-4066-9370-4a1b90a19ac4",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "22d898c2-6797-4448-b2cd-ee47afee0155",
"company_id": "2331e5c9-3cea-419c-a004-fc4d32308c47",
"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": "67d3f95d-22b8-4938-8fc2-b190fcfa515a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "8cfc9379-1b6c-42db-8e11-55d209b637f6",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ecbad8ad-e4d2-43d1-88ca-f44629a0f62f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9d0fbcf9-7673-48e2-9ce4-f381d5d47a6d",
"company_code": "sample string 5",
"company": {
"id": "d23f7481-78a4-48e4-b45d-1ed5c0181043",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-05T20:20:34.197747+00:00",
"sales_territory_id": "0f4c480c-26c6-4d8d-bec7-bab774c07643",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e7e98786-11e0-4f79-b02a-9c504c2235a5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b79b4ab3-8e32-4f0c-8268-704be9c749fe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "97cade86-266f-4ad3-aab0-a68f29c844ff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cefd81f4-e5e1-4493-ac26-910099a8aa92",
"db_currency_id": "91a9a57a-cab5-4781-a306-76e515d0cb09",
"db_language_id": "5433abd7-b612-4de8-8f04-0437205e83d8",
"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-03-05T20:20:34.197747+00:00"
},
"modified_dateutc": "2026-03-05T20:20:34.197747+00:00"
},
"marketing_segment_id": "f4004d8e-6625-44ed-846b-057856ac4cc7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e4dc8f94-49f6-4b00-a499-8a7da8c1134a",
"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": "7b812f2b-d520-43ab-978d-535fed6d134b",
"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": "90b57f9c-4d68-4e4d-9229-69e31365fdf7",
"db_country_code": "sample string 28",
"feelist_id": "faf06a0d-874f-4905-8253-49b32edd236c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0fae43c1-a89e-4a30-a64e-b733fb906a6f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0862a9bf-9ec0-48fe-9c77-4518d62d9353",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-05T20:20:34.197747+00:00",
"db_currency_id": "0c1fe150-14c1-46b7-aca3-0edfdfb1360b",
"db_currency_code": "sample string 10"
},
"company_type_id": "525fa9d8-725f-4abe-a745-609c300f6f9f",
"company_type_name": "sample string 32",
"company_type": {
"id": "2471f0b2-d0cd-49cf-b3b8-825a1b550b98",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7a5906ac-dda9-4aa9-acb2-4e0be0af18e9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "29791d62-5f57-4919-b54d-e075d52a2678",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "96aa46eb-63ca-44d6-9cc6-2b15536cfd46",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1646e044-e06d-4dff-8f0d-c4e8f20deb9a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1ddc199b-671a-48f7-bef7-5445d240fe40",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-05T20:20:34.197747+00:00"
},
"company_sector_id": "02db0501-d7a9-4f50-886b-502272ecd7b5",
"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": "1f208ed9-b609-4406-bb5c-aba555bca885",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3132cdc4-e06b-4f20-9a3f-44832f2b397c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7d14d9ae-fd7f-4d83-bff9-804f5b60ad9f",
"account_manager_user_code": "sample string 56",
"company_status_id": "737e48f6-a91d-4e47-874b-ab8655eb08b2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-05T20:20:34.197747+00:00",
"id2": 60
},
"db_language_id": "1a726ea8-dfe9-4ccb-8210-7256be6dd75e",
"db_language_code": "sample string 7",
"db_title_id": "353a2321-55dd-49ab-9d42-29974a7b1feb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-05T20:20:34.197747+00:00",
"create_date": "2026-03-05T20:20:34.197747+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-03-05T20:20:34.197747+00:00"
},
"modified_dateutc": "2026-03-05T20:20:34.197747+00:00",
"id2": 22
}