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": "ec8dd20e-6368-40ff-92ee-21cd1a47740b",
"_parent_id": "7dafeb63-0da3-4bfe-a8cf-ff04128812b8",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ae66fd8f-75f9-4b5c-b17e-e2c126dfbb03",
"company_id": "a6c6a718-0e33-488b-9b1a-455f78184804",
"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": "a7a9b2a0-b583-4bb7-8228-b8f4093a2ca7",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6876c134-c3c8-418f-a303-6634f69dd21f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c0378e53-5cd9-490c-bd2f-fd0673ec7dc7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "42d73c41-359f-4968-bcf8-9aa5b2e6d516",
"company_code": "sample string 5",
"company": {
"id": "bd8ee15a-5240-497c-b118-a9720660ab39",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-18T04:24:36.2366146+00:00",
"sales_territory_id": "d6a1fcf2-f6cc-434a-9f56-118cf056622f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5c611532-290f-4b18-96a7-3181f6f87d42",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b081bdbb-c3af-419a-8098-477d57ddb902",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "01061d09-567f-41ec-b7ce-c23e383968b8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a658c85-8bf1-4a13-834e-17d037e83755",
"db_currency_id": "52cd81b6-7252-47a5-bc63-abf846c1c437",
"db_language_id": "5d81d413-96a3-44db-9102-aa4be213b99e",
"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-04-18T04:24:36.2366146+00:00"
},
"modified_dateutc": "2026-04-18T04:24:36.2366146+00:00"
},
"marketing_segment_id": "359a6f37-5a87-4b76-9861-e33d03561a05",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "52229d1b-404a-4ff1-b892-70b81130739c",
"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": "c0d005c9-46df-4721-bca2-d30247315365",
"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": "410457f4-5938-41f5-8695-4516504b184d",
"db_country_code": "sample string 28",
"feelist_id": "10739581-2807-4e98-930e-ed6c8ba49719",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b1051a05-b025-4544-a833-1e64bd04a616",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "52c0d2e1-daf5-41c4-b413-c8fa1fc4e930",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-18T04:24:36.2366146+00:00",
"db_currency_id": "b81abfc3-47ea-423e-8b24-6831863e53dd",
"db_currency_code": "sample string 10"
},
"company_type_id": "6288906d-f2dc-4bdc-866b-6df318ca1159",
"company_type_name": "sample string 32",
"company_type": {
"id": "d3fb8a16-2744-4d37-b781-a41697fc75cf",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2753023f-b1e0-412e-8b8e-8ed84316217c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "685bf22c-a234-4e5f-9f06-53c2424d8a84",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dd4dae9a-c0d1-447c-b8b2-9072bd1929f4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "87047984-9015-4df3-b90a-0a1f14474d44",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2ab5a8cb-6923-4aa5-b01e-4910c0db5116",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-18T04:24:36.2366146+00:00"
},
"company_sector_id": "9b5f8693-7100-45ab-8134-fa1513174a8f",
"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": "97e2fafb-21f2-4eac-b078-3ba3353af77a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fcfeecc8-9610-4922-b46d-7486a870574d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "23d05833-79f2-4bf2-a47e-7e416364b734",
"account_manager_user_code": "sample string 56",
"company_status_id": "ad3a0a04-719c-41b9-8f8d-fef189e8877b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-18T04:24:36.2366146+00:00",
"id2": 60
},
"db_language_id": "14fb56c5-76ea-400f-92a4-4485333fa206",
"db_language_code": "sample string 7",
"db_title_id": "210d3a88-0180-44eb-9b1e-87dc6b49dc4e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-18T04:24:36.2366146+00:00",
"create_date": "2026-04-18T04:24:36.2366146+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-04-18T04:24:36.2366146+00:00"
},
"modified_dateutc": "2026-04-18T04:24:36.2366146+00:00",
"id2": 22
}