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": "aa85ddfe-0bb1-4ace-b6c2-3e946d8a0a00",
"_parent_id": "a20a863a-c31c-4c92-b691-ddc8097d221a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "592e3e53-6325-4d84-b2d6-307e086b8a1e",
"company_id": "4caf573b-4851-40e1-8c85-4faad1020dbf",
"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": "72e3161e-4341-45e6-9b11-d65eea05b229",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "4113359a-65b3-4960-8526-defde026b4ff",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "d953f654-f1be-4b32-892b-23c2811136a8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "624cd0e7-a011-47b2-9b6c-c92d05a59781",
"company_code": "sample string 5",
"company": {
"id": "18eadd7a-effd-42ce-bfa5-495807c47cfa",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-14T08:38:29.8781242+00:00",
"sales_territory_id": "75697374-d2f2-4691-af61-f5b053528fae",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "019cc8dd-4f13-40a0-ab6e-87c11050f9e7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8087b3d1-a784-4c48-8fca-082ab94c767d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e796b9e4-e6cb-4829-9928-acba71321590",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "daea4b56-b1ff-4438-b73c-c874b5e9d307",
"db_currency_id": "932ccb29-fb37-4bd4-b3c0-de4530d882d9",
"db_language_id": "1641d3bd-ed0d-4514-903b-525d98b038c5",
"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-07-14T08:38:29.8781242+00:00"
},
"modified_dateutc": "2026-07-14T08:38:29.8781242+00:00"
},
"marketing_segment_id": "f97c014c-1b9d-44e6-a6c9-7b87ab744f9c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8d13551b-465c-41ae-80fb-e5fb9640dafc",
"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": "d2108e46-ec5b-4515-a560-272c5735d358",
"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": "d0fd82e8-fa3a-43c6-a5d3-f72feeabeee0",
"db_country_code": "sample string 28",
"feelist_id": "3801930f-39e0-4f04-9114-7b8ece3b163d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4d01bf6c-1572-42a4-b846-8cf658f1a1f7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6a01777f-b981-48eb-af5f-817078d01849",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-14T08:38:29.8781242+00:00",
"db_currency_id": "b56809bc-f312-45e5-96d4-7a8996d927b8",
"db_currency_code": "sample string 10"
},
"company_type_id": "154cfa35-58ff-4b70-8c92-c1ba1628cfce",
"company_type_name": "sample string 32",
"company_type": {
"id": "d1dfe144-453c-45e4-8f94-4d4a27676990",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f13f0e57-587c-496b-9e99-52ad1cccf963",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2df18413-5167-4702-a3e1-377d561a5c72",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8818cb46-5b02-4336-9c61-c8dfd57f7b26",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2251eece-0191-48f0-8354-71085a805ff6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5d8b6c33-be87-40c4-9dd5-2d082bf32aa5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-14T08:38:29.8781242+00:00"
},
"company_sector_id": "8d6971ce-236b-4869-9e8c-16bb106d043d",
"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": "73c4aff6-32bc-4c3a-96c3-cb128368d6ea",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2262a5b7-f77e-45e4-9b50-04b6a27256c6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "08615e1c-75f3-42e0-b19c-9078c1128bed",
"account_manager_user_code": "sample string 56",
"company_status_id": "ac19c559-9b9c-4164-ab41-892b1fcb38e7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-14T08:38:29.8781242+00:00",
"id2": 60
},
"db_language_id": "4043a312-a6fd-4a91-a507-6c9ad830e766",
"db_language_code": "sample string 7",
"db_title_id": "a277bef4-6e37-423c-8894-e42fc9b0bdad",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-14T08:38:29.8781242+00:00",
"create_date": "2026-07-14T08:38:29.8781242+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-07-14T08:38:29.8781242+00:00"
},
"modified_dateutc": "2026-07-14T08:38:29.8781242+00:00",
"id2": 22
}