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": "d7eab66a-14f3-4def-9ab3-4fee4eb4cb11",
"_parent_id": "357f6519-95fc-46d0-87b7-5bc7181f8f84",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b7937af5-1904-4921-a95d-e1daf5a00b7b",
"company_id": "95b0ec79-2041-41ec-b7f2-fa5069f8b486",
"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": "fae16bf1-a6c1-42c2-9df3-9d87c5ea932b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "643b2e04-5b00-4a4c-b561-3d941ad4faa4",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e0d45a3b-5517-4751-909e-bb7ea09e06c0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "da3dcf6b-0ff5-4836-aa77-d2bd7eee4380",
"company_code": "sample string 5",
"company": {
"id": "8488f742-a6ba-4e56-a89b-b0e8b3fdcfa8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-08T20:08:10.747552+00:00",
"sales_territory_id": "ba631b7f-826c-40a6-8842-4dc555e643f1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7d417678-43bc-47ad-8d61-e59f4e9c34c8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b1cddde9-b120-46b9-865c-48f5282aef23",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cd89d839-fab7-4f61-94bb-c2d373faeb74",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15f5c481-d3dd-4b80-959d-398fdf8f3303",
"db_currency_id": "942d176d-ac72-4486-8f72-a98b9018033a",
"db_language_id": "345af4c4-6c20-49c7-bc03-2ba89c57912d",
"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-11-08T20:08:10.7631788+00:00"
},
"modified_dateutc": "2025-11-08T20:08:10.7631788+00:00"
},
"marketing_segment_id": "7f0b2631-988d-4947-8543-bca5b395c22d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "90376796-6b02-4c73-9aa7-1cecd337d473",
"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": "4da6ebd2-56e6-4126-9153-dc3454c01903",
"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": "c482cce2-72d3-497d-9acf-02a6a293e6ee",
"db_country_code": "sample string 28",
"feelist_id": "9be885a2-7ab9-4c21-8a0e-17292907bd71",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bfbfc431-488b-4f0e-a8c5-2776fcb56091",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "71c6e507-92d1-43e9-87f0-d2374c60cd20",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-08T20:08:10.7631788+00:00",
"db_currency_id": "e8c0a990-77c7-4cea-b10c-2cdb783e2f69",
"db_currency_code": "sample string 10"
},
"company_type_id": "c0996b1f-756a-4389-b7bf-a389bdcc2ff7",
"company_type_name": "sample string 32",
"company_type": {
"id": "5f514978-10d1-4781-91c6-f1d790da3c11",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e642a2d4-c1d1-44f9-b131-1a2b71f7c647",
"sales_organization_code": "sample string 5"
},
"db_language_id": "29ed92dc-aa86-49cd-9188-72a92c1cbf61",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c77d91f0-8b0e-4f23-b58c-937820a8f47c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e8bf118f-4aa2-481e-a4d2-cd959a81196d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "686d29b1-ff3b-42a5-883f-f371b7d0a337",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-08T20:08:10.7631788+00:00"
},
"company_sector_id": "9d23a297-2b44-4003-9c1d-a5533a418e19",
"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": "43aa483d-7047-4cf7-a3d5-54cc7d73e230",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2487581e-dec7-4636-90a7-18a80f93d635",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4e9166b2-f6a9-40ca-abec-71db3e621727",
"account_manager_user_code": "sample string 56",
"company_status_id": "0af7f7d3-fcf9-4394-bbd2-91616f3ad5eb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-08T20:08:10.7631788+00:00",
"id2": 60
},
"db_language_id": "bb293e14-a476-4ce5-bf3c-1de74b40c429",
"db_language_code": "sample string 7",
"db_title_id": "0f78144a-6e4c-41ba-854b-23f5484bcc86",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-08T20:08:10.7631788+00:00",
"create_date": "2025-11-08T20:08:10.7631788+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-11-08T20:08:10.7631788+00:00"
},
"modified_dateutc": "2025-11-08T20:08:10.7631788+00:00",
"id2": 22
}