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": "9a0923d4-778f-4489-985e-0bb51868ad4e",
"_parent_id": "b665160c-2307-4728-aef4-d1b98ae73363",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ced1dbdf-e0b0-4f3d-9a2f-79bd65ec01b2",
"company_id": "228b7046-5207-4560-bf47-862fd5aae9b7",
"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": "ed60c0ea-7e23-413a-a462-19b6f6319ba5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d4c7abf4-7894-4d10-938f-7b4ae67a75e1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "af99c34d-8860-4144-a583-5333d4b2c63d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fd9c8b9b-1dd9-473a-a404-e015db00b78b",
"company_code": "sample string 5",
"company": {
"id": "0e29e17e-edce-49ea-9934-6495b05ad1b0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-18T16:09:51.8135399+00:00",
"sales_territory_id": "c2ad8bd6-81e8-4355-aeec-95b557c18558",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "74c2a7c5-05f9-495e-84f0-66d2311dab6a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bb9b4e09-311d-4467-9b13-ff2c9f205f9e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "be96f037-085b-4dbf-bdfe-20deae9dc7db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41c5fa4f-aea1-425a-946b-7830b7dd5460",
"db_currency_id": "fe2a60ce-49f5-4a2e-a3e9-d8631d91c795",
"db_language_id": "b9f6a003-cbe1-4326-8435-dcc480f5ce92",
"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-09-18T16:09:51.8135399+00:00"
},
"modified_dateutc": "2026-09-18T16:09:51.8135399+00:00"
},
"marketing_segment_id": "abcef911-bb28-430b-b1a1-b1d9ed8888e5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d21fd8c9-bc66-4773-a265-fba7fcb84088",
"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": "5beeb538-6298-4953-bbb9-1504d2e3d5e0",
"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": "afdceff1-34e5-42a0-9c7b-1b23cdaf8462",
"db_country_code": "sample string 28",
"feelist_id": "ec876e1a-44b2-4527-90c5-66bac73c5b39",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "67cad174-18da-422b-9893-030c06aafecd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7641be5e-576a-4883-bb07-f1dd83424b9a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-18T16:09:51.8135399+00:00",
"db_currency_id": "96e67ab0-2981-4a17-8c35-b18a9512bbd3",
"db_currency_code": "sample string 10"
},
"company_type_id": "ab49a748-29c2-4f83-82f4-2844cbfc6ff4",
"company_type_name": "sample string 32",
"company_type": {
"id": "db7e59b2-c7eb-40d0-a515-f5ec7496b0d6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e644a8ba-9a01-4454-ae9c-6e880441188d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ad9ec093-2a36-4a0f-871f-31529954507d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bc4d12a6-12a6-478d-92a8-b59f6d09e4f6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "56a8687b-89d4-424a-8cb9-cb96203307cd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0f2fdd88-6446-4085-b718-d1415c596453",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-18T16:09:51.8135399+00:00"
},
"company_sector_id": "1378bd8c-7e1c-48b5-839e-81433a53892a",
"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": "d6d9cf39-b92c-441b-9936-3bc683cda617",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "99f5a473-253b-43d7-b24e-1bea82b05805",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "87664a7c-b8d1-44f7-a170-9bfe5192b2b0",
"account_manager_user_code": "sample string 56",
"company_status_id": "05e0fa77-65c5-4156-88ed-968ec43a9868",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-18T16:09:51.8135399+00:00",
"id2": 60
},
"db_language_id": "bbfdbe22-2d11-45cd-9090-32378ec4e5af",
"db_language_code": "sample string 7",
"db_title_id": "8c14b7de-a77d-4787-b8b6-83cfe93df0ae",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-18T16:09:51.8135399+00:00",
"create_date": "2026-09-18T16:09:51.8135399+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-09-18T16:09:51.8135399+00:00"
},
"modified_dateutc": "2026-09-18T16:09:51.8135399+00:00",
"id2": 22
}