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": "21d3dbaf-51fd-48c2-bfea-f26fd12325d0",
"_parent_id": "5e421511-5334-424d-bbef-23fc916f070b",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ec299ed0-87b3-43b4-adcf-86c848d6e7d4",
"company_id": "e6020399-37f7-4b3d-8668-d0f721072deb",
"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": "0fa6cc28-3253-452f-97ad-36dcc6757f2a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "81dc9693-f702-492b-8019-744b86354b89",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "7a6fc72b-7135-42eb-ae47-04bc9d2b4d4d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7fd3e624-d800-4cac-a54e-e788a9cb2a1d",
"company_code": "sample string 5",
"company": {
"id": "43fcbc8d-885a-43cc-9e8c-9c3b52bd06d0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-22T09:03:06.570607+00:00",
"sales_territory_id": "09a68c88-7e18-4d11-8a95-8a1de7abf1ef",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "27b556f5-8e30-4f60-bb85-7a4356b76fc3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a7333d8a-a975-4e5e-a40a-73f2800fcedf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9fd5b514-8788-4893-9ca5-2b5377875c12",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e18cbb5f-3df5-4170-9f39-08717c988f3d",
"db_currency_id": "d4e1ae80-846f-4dad-8a37-de10e35437e6",
"db_language_id": "159367b5-1ef7-4597-9658-80e9aa57178c",
"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-12-22T09:03:06.570607+00:00"
},
"modified_dateutc": "2025-12-22T09:03:06.570607+00:00"
},
"marketing_segment_id": "30857e9b-0e8b-43b9-a5cd-ba2ee5cd574d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "daa7792f-b60a-4bcf-9b53-914e36cdbd62",
"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": "37adc429-0ca1-43da-9302-478ae366137a",
"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": "73d8b05b-3618-4f33-8d8c-4db7e7808898",
"db_country_code": "sample string 28",
"feelist_id": "5920d9f6-5a80-40ad-9942-fceb1b4bd963",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "da552bfd-d385-468a-8579-cb7bf4e455ea",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "348701dc-bced-4c51-8664-ff09498165b1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-22T09:03:06.570607+00:00",
"db_currency_id": "0078d16f-a5f9-43c1-b348-ca7e97a30b55",
"db_currency_code": "sample string 10"
},
"company_type_id": "16cb0841-f9a4-4211-a98f-36293d11c95b",
"company_type_name": "sample string 32",
"company_type": {
"id": "300c0660-e6cb-4db5-bad2-9a607a444c6d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "aeafd11c-bbdf-4578-8653-1421a4fb9747",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1541f316-21e4-439a-a2c7-73c5e4897c49",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e789fbe9-9bfa-4248-b41f-be5ff980a550",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "982f94ff-7597-4512-9ce1-1bd37058873d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b7004857-8f77-472b-9219-ca0b4bf81543",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-22T09:03:06.570607+00:00"
},
"company_sector_id": "a9dc8592-d543-4c0c-9770-b6eb03a4b488",
"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": "ad883209-3fd7-4615-9118-662fff2f0891",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "75263f90-39e8-405e-b26a-0a951b021b9f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "710f7eb1-f023-4a61-b224-33559c80449d",
"account_manager_user_code": "sample string 56",
"company_status_id": "8a486ef5-e0fb-40e1-a64b-54b8ca126fe9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-22T09:03:06.570607+00:00",
"id2": 60
},
"db_language_id": "54648bb4-d8c3-48d0-9426-9a364f62e82f",
"db_language_code": "sample string 7",
"db_title_id": "fdbce240-8f80-4c1f-a35b-c38f1a70d913",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-22T09:03:06.570607+00:00",
"create_date": "2025-12-22T09:03:06.570607+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-12-22T09:03:06.570607+00:00"
},
"modified_dateutc": "2025-12-22T09:03:06.570607+00:00",
"id2": 22
}