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": "002001cb-0c89-48c3-a7bf-72140f758184",
"_parent_id": "2ec6e2f7-5330-45fb-824b-f34dbcd19a39",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "7d5672eb-3b27-41d9-a0e3-75e43deaaf42",
"company_id": "205548a5-b7bd-4f01-aa42-0be98404f95b",
"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": "ea48e77a-2076-4bb3-a0d2-147baee93740",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0acf9fa4-680e-4cb7-a3fd-a561f08253aa",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "88ec921c-3d3c-4208-b2e0-3539c00f9517",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0c414171-7b2d-4451-ad31-8ef33343a774",
"company_code": "sample string 5",
"company": {
"id": "7024d0eb-a818-45bf-a9d7-9d4dc987b137",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-05T12:25:07.2073814+00:00",
"sales_territory_id": "e1507b44-cf26-44e1-8d14-8254a0f2fe90",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b0e903a8-8aa2-4168-a67a-2997c82207ef",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5b88ef51-03c5-4c3d-8cc4-349dc68c15ea",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "83f9a03a-377a-4ac1-b115-87314c80ed01",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8217d60c-c66c-4d61-b8c5-4472642f8986",
"db_currency_id": "f75bd181-9317-4129-ae94-e8fb631ebbb7",
"db_language_id": "5898b311-2425-4cfa-9c64-693ffee3101d",
"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-09-05T12:25:07.2073814+00:00"
},
"modified_dateutc": "2025-09-05T12:25:07.2073814+00:00"
},
"marketing_segment_id": "fea4b0c3-27bd-4cfe-81f4-a7ab4e623ac3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7b5ea37b-ac77-40e6-9ca8-d21ba64d91d4",
"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": "b7ec0527-1591-4813-aa5a-2a578b65e09a",
"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": "cc31e5d7-1a3d-496d-9c60-34de3e409e25",
"db_country_code": "sample string 28",
"feelist_id": "0ae6d97e-ff8c-46ae-9f65-fa7c38334947",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "985e6d0d-5aab-4c21-aba9-447c2840c0cd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2b2a3af6-54ab-4805-9e02-bab3a158a9ad",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-05T12:25:07.2073814+00:00",
"db_currency_id": "38fd0fd0-b1d2-4ad3-a732-9099bf3db346",
"db_currency_code": "sample string 10"
},
"company_type_id": "03d1067f-8bcd-491b-861f-989c7dc36395",
"company_type_name": "sample string 32",
"company_type": {
"id": "de91e340-3f28-4d2b-832d-6584c95ae4fd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2759ccff-bf4d-4052-bf40-3ca267f5b1cb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5df1236c-0154-4ad4-99fc-916b0b731330",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6d170a6b-6227-40fe-a278-2c5460a9ed07",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ffee975a-8871-4458-8ee3-e5f60f12d19a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8fdc15d9-b25c-42a0-9a54-10e46124274a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-05T12:25:07.2073814+00:00"
},
"company_sector_id": "e39038ac-5630-4711-8100-95fd36a6f6a9",
"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": "6e610c74-2f45-48a2-aabb-49aa813275b6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1c82d05d-3ac8-457b-a7f2-512e83b1c539",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "35117479-1651-4104-817a-a6727829867b",
"account_manager_user_code": "sample string 56",
"company_status_id": "57d97db1-930e-4b15-b621-f5d4a8f5fcc2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-05T12:25:07.2073814+00:00",
"id2": 60
},
"db_language_id": "8158883a-15cd-490b-9902-025ebf6db8ea",
"db_language_code": "sample string 7",
"db_title_id": "3cd86750-b75a-4b3e-8170-fe4e306baa6c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-05T12:25:07.2073814+00:00",
"create_date": "2025-09-05T12:25:07.2073814+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-09-05T12:25:07.2073814+00:00"
},
"modified_dateutc": "2025-09-05T12:25:07.2073814+00:00",
"id2": 22
}