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": "5b3de64a-0f16-43a7-a6f3-d267575fe693",
"_parent_id": "313410bc-eac4-46e3-9f0f-bce6a3373dd8",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c06117e7-ec1e-467e-b3b4-628daf85cea2",
"company_id": "bcaef5c2-bf7b-4a28-af1c-09bbaae97f19",
"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": "4906d658-3979-4511-a214-e831e2e798d3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "53f84da7-fb83-47e4-a67f-a00fc4feb09a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ddffd382-3771-472b-a0eb-4b902aeb1a08",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7140311e-d7a7-4c4e-bb48-7d1c04eb58f4",
"company_code": "sample string 5",
"company": {
"id": "836ed4fe-059e-47a8-bb00-49c871d09235",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-18T03:51:41.8436463+00:00",
"sales_territory_id": "91cc5cd0-2db0-49db-ab40-e0f88382ba9e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1224d94d-5c19-4903-a0b8-53e9884a8911",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7bad8163-c6b4-4052-b328-5bb7403fa373",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1111adfc-6fb1-4a18-983a-8af9a2866103",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac3f60d5-66c1-4bb7-ac44-580264858046",
"db_currency_id": "c7e0f0ac-6866-404a-8130-f3c3c853e059",
"db_language_id": "e65526ce-2564-45d5-b9a2-701fc552cfef",
"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-04-18T03:51:41.8436463+00:00"
},
"modified_dateutc": "2026-04-18T03:51:41.8436463+00:00"
},
"marketing_segment_id": "96bfc1e8-8760-45de-a626-92dc67f5e00f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f9b6870d-651d-4608-bd0b-414e1e849f5e",
"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": "1af51a22-1f49-4973-b22b-4178a625aa64",
"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": "4444b583-9df1-4c07-8028-de3e35af30a8",
"db_country_code": "sample string 28",
"feelist_id": "a323e780-44cf-4304-8e3e-03ed94d622e9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "96c1ad00-8939-4f9d-967a-48e422df58eb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "568b4770-a84a-4a52-80b7-cbd945b18618",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-18T03:51:41.8436463+00:00",
"db_currency_id": "d3a01ccb-d872-443c-85ed-3fe8de2f33cb",
"db_currency_code": "sample string 10"
},
"company_type_id": "e3592589-7b8d-4fad-981b-e00871a4840d",
"company_type_name": "sample string 32",
"company_type": {
"id": "35fbe3a7-1406-421e-809d-b8bf398217cc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4ad7d69b-386b-465a-b305-a5c62bd9cde9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "872c2c84-2846-4a79-a05f-4a524503a960",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a9a4afca-5045-45a6-91cb-ca2a804b172d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c6371e65-8d84-43ee-9f80-10f01b72d8fe",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4a8e17ab-7615-45a4-bb99-55607bbc7465",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-18T03:51:41.8436463+00:00"
},
"company_sector_id": "6e443dc4-aa6b-4ed8-ae43-548474cd1dbe",
"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": "9e3c7b2d-ba84-4103-8809-eabbbcb1a833",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "14fe993c-59f0-493a-b4bd-8326fc8f2768",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1f51e7d8-692f-44d2-afe5-23e84b166e32",
"account_manager_user_code": "sample string 56",
"company_status_id": "f9f2a061-ac2d-4954-9821-5fe495c33de3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-18T03:51:41.8436463+00:00",
"id2": 60
},
"db_language_id": "648ba774-a31f-4375-8f94-51a254185de5",
"db_language_code": "sample string 7",
"db_title_id": "3baf1fba-e1e2-4fbf-b322-86cd3f329d1e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-18T03:51:41.8436463+00:00",
"create_date": "2026-04-18T03:51:41.8436463+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-04-18T03:51:41.8436463+00:00"
},
"modified_dateutc": "2026-04-18T03:51:41.8436463+00:00",
"id2": 22
}