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": "cd9fcef2-d10a-4d67-85d4-57c62fb0ec1d",
"_parent_id": "cab431a9-3c9b-463e-b652-98a9e282c354",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "8b133013-4e84-4cb4-815b-d47dc27956e7",
"company_id": "1d0eac76-d7b4-42a5-8867-a8137e56bc23",
"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": "dfdaf48f-eac1-4537-bf33-1f71274fd3c6",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ed8d887a-9701-4603-bc3d-cbb033aecb4c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "b05a8207-eae2-4fc8-b75a-6f19c4ca920c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4136e5ad-87c4-4c2b-a7db-bd2ee14b1124",
"company_code": "sample string 5",
"company": {
"id": "a24f818c-0549-4fa3-ab6e-68c86a42de2a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-25T09:17:27.5360497+00:00",
"sales_territory_id": "0da4d424-c7e1-4348-a4f6-801186640615",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "af860dc8-791b-444b-936b-825ac624d1d2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "65bb705c-69c9-4f2c-815e-2691b0b38a12",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "39b0d6f6-8942-4d90-933a-dfaa143de5a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25d7b0a5-3afa-4045-8758-dd342afcb4fd",
"db_currency_id": "8fddba1e-201d-486d-a586-9b7eac435aeb",
"db_language_id": "c8dc1222-1795-4c5c-8d00-35877617ec50",
"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": "2025-12-25T09:17:27.5360497+00:00"
},
"modified_dateutc": "2025-12-25T09:17:27.5360497+00:00"
},
"marketing_segment_id": "50267cbd-9ce4-4914-b8c2-7ed0412dd45e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3ad9a37d-1b2c-4424-89ac-1728921de4fc",
"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": "ce71dcbc-6bb0-42fa-b6b9-3b16de44508a",
"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": "14cfc902-e92d-433f-999e-dabf25fe0914",
"db_country_code": "sample string 28",
"feelist_id": "3588864f-1379-4b30-8716-3a4a5f80cb77",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9777275b-e759-4454-917f-dfd5fb026f6a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "17fe455b-c55e-467a-945e-e0d73fe33360",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-25T09:17:27.5360497+00:00",
"db_currency_id": "41466bfc-80cb-4c80-bd5f-28b3738ebef6",
"db_currency_code": "sample string 10"
},
"company_type_id": "2f70824a-6119-40c2-9acf-4ad023b28a98",
"company_type_name": "sample string 32",
"company_type": {
"id": "e46ba3f3-1240-40a7-880a-11c322fa6dc1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "55d354cb-bcef-41b9-a55e-4b8571cbd831",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5507ba3f-c0cd-4f29-b3a5-843a0e0934e7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "93c017a6-3cea-45ff-a4f1-c5f93fff1987",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "156d21fe-5bb2-4ed5-9038-e0db27644ff2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e45eea41-82a1-4bde-96d1-235fe331a805",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-25T09:17:27.5360497+00:00"
},
"company_sector_id": "214084d5-068c-491f-8af7-6f551400adc1",
"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": "3c382e39-ec01-4670-b992-e88d7175e5d1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e9a7d7ca-4009-4fae-8a57-3be40f1e926a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "29809ac3-0a27-4c02-af97-aaddbffd61c2",
"account_manager_user_code": "sample string 56",
"company_status_id": "2e46e8bb-d552-423e-9dea-e40a7acee498",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-25T09:17:27.5360497+00:00",
"id2": 60
},
"db_language_id": "91789be9-9f2c-4ad5-9127-5013434472eb",
"db_language_code": "sample string 7",
"db_title_id": "2c7c5c22-8272-4284-97b9-f2886b2228b9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-25T09:17:27.5360497+00:00",
"create_date": "2025-12-25T09:17:27.5360497+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": "2025-12-25T09:17:27.5360497+00:00"
},
"modified_dateutc": "2025-12-25T09:17:27.5360497+00:00",
"id2": 22
}