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": "04432815-409c-40e2-b88f-be555303ccde",
"_parent_id": "470fd43c-709d-4ed3-893c-52e34ec3ac72",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ac27e0de-9f37-44de-8ae3-a7779f215417",
"company_id": "ebc9fefd-ae63-4fd6-8e02-be80bc8be8c2",
"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": "74938d6d-1b7c-422a-9da9-3281a1e816f8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "70466f41-ba4c-49ef-b2f3-9d37a16a9316",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9e8e1786-dd80-4881-b582-d3bd1eb38c0c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "68b45647-12cf-44f5-bcf3-81824759e739",
"company_code": "sample string 5",
"company": {
"id": "4a8e5b1f-c26e-4b37-ac9a-12ddf97731b4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-19T20:06:21.7573012+00:00",
"sales_territory_id": "1e2e97f3-a9d6-4f46-a309-5137a1c9a2e8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "46500006-6257-4566-8d91-9b46914bdd22",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fd4de7e4-8d0b-4d2b-b1a4-2b7812400fe7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "57c72b05-5b95-4de1-a179-527a03503c8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6b65fe74-fbee-44eb-a362-6d67dd920522",
"db_currency_id": "82fec106-366d-43a1-beb8-859fed6ef1b5",
"db_language_id": "083abd93-29e1-404a-92ae-19bab9a979ca",
"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-08-19T20:06:21.7573012+00:00"
},
"modified_dateutc": "2026-08-19T20:06:21.7573012+00:00"
},
"marketing_segment_id": "1628295b-dbfc-4e60-aabe-a977379cf365",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b5d0b31a-2ec8-4417-9694-a434f60af9a4",
"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": "2bb92310-d4f8-4c72-88b9-3a49f138bda2",
"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": "e484084a-bc6c-49d1-a9c6-a625d2a08ebb",
"db_country_code": "sample string 28",
"feelist_id": "32a754fa-d766-4766-8fbe-fb410793a001",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5e707015-c420-4c4a-8272-109ad68ae07c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fb2ab0e5-3a3c-45c8-aef9-47f957d83dda",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-19T20:06:21.7573012+00:00",
"db_currency_id": "36d5f75b-3552-4e7c-afaf-973ea6259390",
"db_currency_code": "sample string 10"
},
"company_type_id": "bf4c674b-c817-4b6e-8b5a-03108a0d33c8",
"company_type_name": "sample string 32",
"company_type": {
"id": "99717ccb-c1ed-4949-9f90-c363506045dc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1348a46d-523b-4840-9d9b-ded549310ae4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8e095398-354a-4faa-bf3b-a715f30df076",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ded5e632-2dce-4755-ae9a-4dad596acf98",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "71fa4614-e191-466c-8801-e7d2ca64779d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c3bed9da-1528-4054-887e-c16f13af1baf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-19T20:06:21.7573012+00:00"
},
"company_sector_id": "87c2c2b5-2dc8-4e71-8d4a-db17e8b24c86",
"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": "5083ac24-6d2c-47d9-9c83-7c87eebc3a52",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "846e875a-364d-43e7-8b0c-00355febe3ac",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9f78d8c9-ad75-4257-9577-692530b9f6d6",
"account_manager_user_code": "sample string 56",
"company_status_id": "e20dd7c7-b096-4b05-9d7a-565fbefbaf3a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-19T20:06:21.7573012+00:00",
"id2": 60
},
"db_language_id": "ad5851dd-99dd-46ed-b33e-1dfea054e3a3",
"db_language_code": "sample string 7",
"db_title_id": "cef5bdf9-e0d3-45c2-b1b1-442768d59074",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-19T20:06:21.7573012+00:00",
"create_date": "2026-08-19T20:06:21.7573012+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-08-19T20:06:21.7573012+00:00"
},
"modified_dateutc": "2026-08-19T20:06:21.7573012+00:00",
"id2": 22
}