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": "75a976d4-a302-4032-96e7-05058d793d52",
"_parent_id": "441fb10c-ae09-47e2-9932-3ed946997bbe",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "5b18400c-14a8-4f73-8061-f89e219a7318",
"company_id": "eb5b89e4-8931-4ec4-9d5c-08e4f62af9db",
"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": "76b93e2b-44e3-4e3b-9bd0-555398597fa8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "36f6ba5f-e9c2-48d5-b47b-74a8c53a1a39",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ecf7aa3a-1dcb-40ee-b3da-3a7a171e4a07",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7873cea2-2dc1-428b-9838-f2ad22b66991",
"company_code": "sample string 5",
"company": {
"id": "695357f2-6955-4617-a2a1-8d8443522ff5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-05T10:39:20.2214274+00:00",
"sales_territory_id": "969084bb-ca4f-4e55-927a-d7498078bf73",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9e9aeee2-13de-4077-893e-21acf4ba6c82",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "024ec98d-0bcd-4beb-aac7-ad79e014e300",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "435ad369-b835-4fa6-9613-22913be7212f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a7c670b-60a7-416c-8b5a-643fb328b18f",
"db_currency_id": "866274e1-a570-456f-9b93-c1a07457bbe9",
"db_language_id": "9ad2eb72-6109-42b8-819d-8061edc4a506",
"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-06-05T10:39:20.2214274+00:00"
},
"modified_dateutc": "2026-06-05T10:39:20.2214274+00:00"
},
"marketing_segment_id": "7dd74ee2-a1e2-4de4-a0ae-eca905b50f6a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "45b9043e-8440-4937-aef1-0bfdbf08a331",
"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": "72dd8772-4683-495c-86fa-e77db4dc5881",
"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": "58fc41f8-3a73-44ef-9e04-153309719b98",
"db_country_code": "sample string 28",
"feelist_id": "ab65f322-db59-4aab-bb2f-53262ad256cd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "80e85284-f027-496c-99b4-e9eb91752f4a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a74e704a-e856-43b0-9fb4-8d88a6c539c6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-05T10:39:20.2214274+00:00",
"db_currency_id": "cf75d4d6-67fb-4b78-90ad-14fefbd2305d",
"db_currency_code": "sample string 10"
},
"company_type_id": "1c90246f-2767-4bc2-a7a7-347afaffeb83",
"company_type_name": "sample string 32",
"company_type": {
"id": "bd3de0c7-c651-4054-a813-b33507f1aac0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0a725eec-b89e-4df6-bd62-af204382c035",
"sales_organization_code": "sample string 5"
},
"db_language_id": "cd549f98-8b4e-4ed7-90a9-0eba3e116b5b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "adc00cb3-f956-471e-a836-a2ac50dedccf",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "92cb79c9-0904-456c-8fdc-15cff80d2a5e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ae26887b-7a45-4fbb-bc07-e0bdfaa28fd1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-05T10:39:20.2214274+00:00"
},
"company_sector_id": "afca254f-802b-407b-b012-79c4c84d60e2",
"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": "d010e9f1-33bc-4c96-9e7c-5d06c31fac7d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5ba53524-c4b7-4c7d-a020-c141d232bd84",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e172c9fb-3775-4f48-828a-e6ab747da753",
"account_manager_user_code": "sample string 56",
"company_status_id": "a3d997a5-166f-4630-bbad-24a7b41240c8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-05T10:39:20.2214274+00:00",
"id2": 60
},
"db_language_id": "3c52cf91-59ca-433a-9a53-1e8c3e962514",
"db_language_code": "sample string 7",
"db_title_id": "9988cde2-981d-4a25-9d76-e0908a529e42",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-05T10:39:20.2214274+00:00",
"create_date": "2026-06-05T10:39:20.2214274+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-06-05T10:39:20.2214274+00:00"
},
"modified_dateutc": "2026-06-05T10:39:20.2214274+00:00",
"id2": 22
}