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": "473d04b6-5012-413d-b0f9-ce859d81baac",
"_parent_id": "3dd60d3b-17ec-4e38-9a1f-104879fe1fac",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6f570d4b-310d-4efa-ad77-d591b7149a7d",
"company_id": "bf16e0a9-3a19-4e5d-bf6c-6b0d4ea88eee",
"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": "5281d5be-ca2e-45ee-8a9d-cf97c55d21ff",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6d1cab33-9972-4113-b3f2-4f7ec0af7ec8",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4cb7cdfa-dbc4-4949-9058-e691322038c0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e1d5ca33-ccf8-42ac-960d-c47de4b6febc",
"company_code": "sample string 5",
"company": {
"id": "4d8feba7-6120-43fd-b8f6-2543465e1d30",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-13T10:54:59.1536008+00:00",
"sales_territory_id": "8f06cdb8-6198-496f-a61f-830e0adb1bad",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "706231e7-6fe0-4e66-8973-dd1d0d79ac8a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1067b622-24b2-441f-8e28-c7570f2044ea",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "123f244d-9db2-4108-a950-7aa1d1aed58d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71ffa061-e0a2-4bb0-bbad-626fe5e10a53",
"db_currency_id": "713d1a23-4e74-46a1-8901-4a8e0cd863c1",
"db_language_id": "54bd9604-5045-487d-98c1-4190d80d7135",
"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-11-13T10:54:59.1536008+00:00"
},
"modified_dateutc": "2025-11-13T10:54:59.1536008+00:00"
},
"marketing_segment_id": "cfcfa93f-3691-4dd3-b911-2d8fa1a65581",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "34bcbf4b-8d1e-4162-a148-c40996ca6db6",
"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": "becc7f34-60d5-4a8a-97d0-5b976cdd63b2",
"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": "81e18fd6-59a3-40b1-bc8d-0a061161bf58",
"db_country_code": "sample string 28",
"feelist_id": "7a1d02bc-5f8f-49ca-828f-ee92a6404413",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6af00e07-5037-4b64-8c37-43db3a996950",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bd6886ff-1b80-4bf9-828d-44aab8856db1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-13T10:54:59.1536008+00:00",
"db_currency_id": "fb7525da-d029-42bf-b165-eb9ee323f137",
"db_currency_code": "sample string 10"
},
"company_type_id": "5bc78884-d30e-437c-a0f9-3bf3d8e563cb",
"company_type_name": "sample string 32",
"company_type": {
"id": "537fe6ef-0cc0-4959-ad03-61b26fe48bbd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7c1677da-f5c0-4741-8d49-ea2a08bed4e4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "38333336-437b-4451-9866-320e5b669255",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "90ae93e5-9933-47bd-a88e-9d0e78dd2df0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fa5cc187-ca8f-40d6-bc95-12c61899956b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ac332880-3517-4de3-80de-281fe03fa24b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-13T10:54:59.1536008+00:00"
},
"company_sector_id": "9d943302-d005-4776-a18c-5fb53cbcf668",
"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": "2be33a13-2f22-458d-83f9-5e1a0cdf2fa3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1ef18cf2-8ec0-4ef3-bc47-5374f8cdc82e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "65b021e7-e5d7-4619-ad22-d22d9fd170b1",
"account_manager_user_code": "sample string 56",
"company_status_id": "19e50c5e-1152-4d95-a8f0-41879f13e43d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-13T10:54:59.1536008+00:00",
"id2": 60
},
"db_language_id": "98c98f89-00dd-4241-bc6c-1b8e3975af68",
"db_language_code": "sample string 7",
"db_title_id": "4335caf5-b7f7-483a-a144-af4673c035b8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-13T10:54:59.1536008+00:00",
"create_date": "2025-11-13T10:54:59.1536008+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-11-13T10:54:59.1536008+00:00"
},
"modified_dateutc": "2025-11-13T10:54:59.1536008+00:00",
"id2": 22
}