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": "c5e3a9d9-3544-445a-9103-026c0fe6c4b1",
"_parent_id": "1f5eda6f-79b5-486c-8efa-da3806bb1763",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "d83e9b58-a387-425c-aa43-ff0635db01e5",
"company_id": "9039b2da-637e-4053-bfa6-60790b3124ed",
"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": "394cd7a6-df98-49fe-b7b4-0899103f51f1",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "540bd334-1c6c-4ee5-92ec-1bb39fb72f71",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0bd88856-ab04-4275-8703-6f02925f2b5c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b20dc4c1-2589-4b70-8679-412de4521adc",
"company_code": "sample string 5",
"company": {
"id": "e16a711e-385a-418a-9e20-597c771c313f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-17T11:56:43.6688072+00:00",
"sales_territory_id": "ba3f1749-ce2d-414b-9600-afcc68cfc249",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e95a3d7c-7930-402c-945e-b6bad1341ff5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "12be0649-8927-4a7a-b371-17126a671d3e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7a3ca746-47ff-47bd-97b2-a15e4726b279",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c658afea-d341-4f30-a9af-b6c7897848bf",
"db_currency_id": "2ebf2678-27d3-4fb2-ab69-3e182485b220",
"db_language_id": "b87bf9d8-1fcf-42e5-acbd-bdd116de8ba5",
"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-17T11:56:43.6688072+00:00"
},
"modified_dateutc": "2025-09-17T11:56:43.6688072+00:00"
},
"marketing_segment_id": "250fc249-db85-4c8f-9a11-4c4cce917e1e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "39517dbb-98bd-4e5a-a812-206e8caa7e2b",
"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": "fae33f77-c81f-490d-9b88-39eb5a043fb5",
"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": "e90e63d8-236f-4b67-b510-fb0f7971d6d7",
"db_country_code": "sample string 28",
"feelist_id": "b2892770-f6f3-4af5-83e0-e45f765a9b47",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1a833f02-ac13-4699-ad80-d43b0fb9b853",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b239d2f1-d004-46c2-b75c-41b870d0aca8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-17T11:56:43.6688072+00:00",
"db_currency_id": "476bda3b-7d45-4d9f-b4c9-a3d7a15352d4",
"db_currency_code": "sample string 10"
},
"company_type_id": "0f4a2fad-6c2b-46b2-854a-216c7c87b303",
"company_type_name": "sample string 32",
"company_type": {
"id": "1872ba85-79e0-478c-bffb-0b3abd94a132",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "41011f96-e7df-4af5-8692-3bdc4c0a1017",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5dd6e4db-c079-45a1-94b1-e73c4037b9d3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "29838666-ba53-43e6-97b8-207406f909fc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "39af99ff-f2ab-48c7-a4dc-33843028c83d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "eee1e69c-1896-4ef6-b41c-2a9b16e2a991",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-17T11:56:43.6688072+00:00"
},
"company_sector_id": "f3805d1c-c6ef-4ff3-b7ce-e3107e7b121c",
"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": "b2fe9dc0-a665-4680-91aa-bded6258f6b0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "26b5dbc9-69d1-43e0-9300-a8a5b4e04797",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3e7d586a-85f7-4431-bdba-16b2b4d7f7dd",
"account_manager_user_code": "sample string 56",
"company_status_id": "aff8d38a-5749-4787-b1b0-cf7d784731a7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-17T11:56:43.6844342+00:00",
"id2": 60
},
"db_language_id": "cf2960c7-85fc-4a8b-9f06-989b54782dbb",
"db_language_code": "sample string 7",
"db_title_id": "16a996f3-fe95-4463-8f3f-353d897c1e82",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-17T11:56:43.6844342+00:00",
"create_date": "2025-09-17T11:56:43.6844342+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-17T11:56:43.6844342+00:00"
},
"modified_dateutc": "2025-09-17T11:56:43.6844342+00:00",
"id2": 22
}