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": "01da4353-efe0-46ed-9adc-699f83c8e21a",
"_parent_id": "e7d99c71-ba12-4605-958a-bffb5c1a52e8",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "631b2976-a228-4f5f-93cc-0b8db41cab73",
"company_id": "648a1246-2abb-4f6f-b7d5-36e23c0a9caa",
"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": "e7ab91dc-b0b8-44a7-8085-685a52bd65fa",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "9ffa7a99-c0fa-4c2f-9963-a15d7319101a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2514279b-a61a-4bc6-a207-800c1620cf28",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "68392709-5349-497e-8efd-008de1071790",
"company_code": "sample string 5",
"company": {
"id": "613a9309-01a6-4091-9137-ad50f5da70a1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-28T04:33:01.0046782+00:00",
"sales_territory_id": "7cbff476-b9d0-443b-8d74-baa1283caa25",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5f153428-f51c-42e0-b9f9-7b359b7b2e3f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "60772c51-743f-411f-9a4e-ca37719c8807",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "43fac088-2e79-4bf5-952f-535fee50eeb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1bf0c863-a09c-416e-9b04-81fb6f1ac5e5",
"db_currency_id": "d3da252a-4535-4aec-bfb0-980f12b51b23",
"db_language_id": "46a08f7b-0892-4d60-bf21-193625dc0a53",
"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-28T04:33:01.0046782+00:00"
},
"modified_dateutc": "2026-08-28T04:33:01.0046782+00:00"
},
"marketing_segment_id": "58628358-fc7a-4262-90e5-a3f64791bdb3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6c2f2dfb-1f06-4cd0-b8ed-842f1d236752",
"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": "200ff533-dc06-48af-9e4f-cb6b041d11bb",
"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": "3d886f3b-f70a-443e-bcac-f7a5819d809b",
"db_country_code": "sample string 28",
"feelist_id": "ca30abba-2b00-4523-9655-3319a6543688",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8c1491b4-f5ff-47e9-8a98-5497a7d0b62c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e87e61ba-5947-4155-90f1-b07d1da7081c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-28T04:33:01.0046782+00:00",
"db_currency_id": "09f941fb-805e-4a7c-80cc-573f962af881",
"db_currency_code": "sample string 10"
},
"company_type_id": "5f2500d9-6f32-47e4-abbd-7b9133248c25",
"company_type_name": "sample string 32",
"company_type": {
"id": "9e49b5c9-dab9-45b6-80e7-c5781222de8e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8e846554-3e02-45fd-b893-63742b5fd996",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f0eb9f73-bcc7-4857-a10a-3cd4b783b4f4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "32f410b0-e405-446b-a48b-2c7a97774ae2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "181a7e89-a861-453e-8cb6-241b02ece308",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b881c7e2-cd47-401f-83d6-aac5d97a670e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-28T04:33:01.0046782+00:00"
},
"company_sector_id": "3d59d685-b33f-4b17-932d-d679c37fb7c1",
"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": "98c754ab-84f7-4788-9cc2-8415f1b1b588",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6b7e61c4-2967-4746-a5dd-aecd7930c786",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "891972de-d29a-490f-a31c-4f4ccf744ab8",
"account_manager_user_code": "sample string 56",
"company_status_id": "f59e788b-6984-40b9-9c6c-1c565b0699bb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-28T04:33:01.0046782+00:00",
"id2": 60
},
"db_language_id": "3c47b1bd-7360-4f67-afed-2536d341554b",
"db_language_code": "sample string 7",
"db_title_id": "71c0f299-854a-4450-b9ab-bcfc937ae53f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-28T04:33:01.0046782+00:00",
"create_date": "2026-08-28T04:33:01.0046782+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-28T04:33:01.0046782+00:00"
},
"modified_dateutc": "2026-08-28T04:33:01.0046782+00:00",
"id2": 22
}