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": "1381b5e6-36e7-41ff-9331-d50c79d328c0",
"_parent_id": "27788d5d-ee11-4886-8821-64dccad2598c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "92d812c2-b160-4187-b67a-d8ae94237cd9",
"company_id": "a9a9772f-1a46-4d13-a47b-5fcd712806d1",
"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": "c35dc70d-7c7c-4042-b940-1e43f00ffa9f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "68a1d989-4d30-4534-873d-5814bfc99617",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3bfef755-74a0-41c1-abd5-d45835823bb5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fd07b76b-caab-4294-a741-dbaf8ed23333",
"company_code": "sample string 5",
"company": {
"id": "05cfca11-0c69-45fa-910c-2c90434d6b2d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-11T21:34:50.3308154+00:00",
"sales_territory_id": "ac4c14ae-f829-4e0c-9689-4d19af3ad57e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a4265658-843b-4366-863c-bb2880300cc4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dd648eb7-e5af-4ff6-aae3-adacdaf7769d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8b86786f-8fe5-4cdc-8c18-a9294c0d0022",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e90238cd-64ad-4525-be37-b696f9403711",
"db_currency_id": "b0f32523-c969-4d50-93d5-7915623a664b",
"db_language_id": "ce6f6d9d-faa9-4edb-afbf-7ce810c96925",
"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-05-11T21:34:50.3308154+00:00"
},
"modified_dateutc": "2026-05-11T21:34:50.3308154+00:00"
},
"marketing_segment_id": "d4299d86-c5c9-4cd2-b57c-15ea21d6d429",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1efe2e8c-e069-4f4e-8286-5f65eadebbfe",
"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": "16f66dc9-2a81-4f2c-a241-638f4e497b30",
"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": "1917cc00-6545-4b35-87e3-dfcd71b1d128",
"db_country_code": "sample string 28",
"feelist_id": "505b1f10-5de5-4fda-86ce-bf1076581aa5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d4410ac9-d1e9-4831-9e15-3f33b0486da2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "91a83647-bc80-4cec-8c28-ea77f1d0087a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-11T21:34:50.3308154+00:00",
"db_currency_id": "88b9701b-81b2-4caf-8238-40d1cf0206de",
"db_currency_code": "sample string 10"
},
"company_type_id": "8fb08cb3-9ba8-470d-ae3c-a4a2e8b9215a",
"company_type_name": "sample string 32",
"company_type": {
"id": "0159667e-cec2-4512-a572-62bf435b0f2c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "647b1793-27b0-4e56-8d70-6fdd6ed66354",
"sales_organization_code": "sample string 5"
},
"db_language_id": "de1521a7-63db-4b4d-b1a2-e782710c9858",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "733376b9-d7f2-40bf-8dd1-8762e0f6c19a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "71e6a50d-302a-41c1-a20f-0bc3e94587aa",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bd103fac-e389-4ecd-a82a-e72cdaa05283",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-11T21:34:50.3308154+00:00"
},
"company_sector_id": "c7ec02d1-bc35-45f9-b28c-95976781b830",
"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": "468fc0ff-bc08-4453-bca8-4fb73ad3870d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "67abb9e0-9598-4d34-b801-28d1769aa328",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c9afe8a0-9898-4c52-a0db-d418a7979e9e",
"account_manager_user_code": "sample string 56",
"company_status_id": "3d772d63-248e-4859-bd25-69210f2f0673",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-11T21:34:50.3308154+00:00",
"id2": 60
},
"db_language_id": "be14f3c8-bda8-4149-b1cd-b9c882a724d5",
"db_language_code": "sample string 7",
"db_title_id": "3e0e21f6-628a-4e88-908e-2c4b3d5af0bd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-11T21:34:50.3308154+00:00",
"create_date": "2026-05-11T21:34:50.3308154+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-05-11T21:34:50.3308154+00:00"
},
"modified_dateutc": "2026-05-11T21:34:50.3308154+00:00",
"id2": 22
}