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": "f53d652f-0585-4546-b8f2-b274173dd38c",
"_parent_id": "43362f91-419b-42fc-b753-fe64389e99ef",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "7e3bcab6-031a-4f16-8b2e-21e6cb5c1a5e",
"company_id": "7aef16f7-c3ac-4824-a5b7-45fd16a730e5",
"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": "8e63ab00-bdcc-4d7d-a516-4bef4f83bd19",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ea67df09-b5a8-405a-8c6c-41aa4664533a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e664a940-2419-474a-a192-dc21b3dfbb9a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "44e2758a-185e-4548-85b2-1d8d6fefd611",
"company_code": "sample string 5",
"company": {
"id": "3db2a963-6595-4c87-8a4c-95fea98729bc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-05T06:05:21.0785514+00:00",
"sales_territory_id": "beb3dd17-6ef9-4d1b-8198-22eb347454e4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e6df64fb-3713-4663-8df7-033a069cfd24",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8ec936bd-4976-40fc-8cfc-26affbf27213",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6c9d65a5-2b6a-47ed-b006-8f9a15dbdf35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "993efc78-7116-4c3d-9123-c2f786d453f5",
"db_currency_id": "df452dcb-d4a3-4fc8-b648-d36bdab02317",
"db_language_id": "3eefb00c-e7f5-454b-bd9c-ee69675201d8",
"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-05T06:05:21.0785514+00:00"
},
"modified_dateutc": "2025-11-05T06:05:21.0785514+00:00"
},
"marketing_segment_id": "45f40238-b741-4639-8b09-0cb287fed67a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "64b27234-ef2a-4c97-8949-b18089f74784",
"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": "72783b09-fc79-4a67-8749-7a408c900b96",
"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": "f6a4ed51-5217-4c5a-82b6-69f4c4acb039",
"db_country_code": "sample string 28",
"feelist_id": "8a8d84f5-8832-4377-8cda-69a6b8a7bbab",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c65a52e0-b21d-4a45-8280-811d1f62dd8e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "945f808c-b213-40fb-91e3-ab4bdbf8b882",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-05T06:05:21.0785514+00:00",
"db_currency_id": "b98ec21f-723b-4c06-9aa5-2862cfc9d284",
"db_currency_code": "sample string 10"
},
"company_type_id": "1b7ae8c3-41ce-4df4-9dcf-32301b75b919",
"company_type_name": "sample string 32",
"company_type": {
"id": "2be8075d-a1c1-41f2-a133-10eb7968df4d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "57b3cc6c-c396-422a-8150-97d646415bc2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5356baa2-837b-4c2f-aefd-442d957825b0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b5628853-e6a8-44d5-827b-d2a676fc8d39",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e2045b57-876f-4ec6-9626-b799b4641d2e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "11c5c768-56a6-44dc-b34d-ae061e416e82",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-05T06:05:21.0785514+00:00"
},
"company_sector_id": "b32302ec-9059-42b9-bf5d-7586b65512fb",
"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": "02a28192-62e5-47e2-bfd1-0d1f0a8c1d6c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "49ed07f4-7851-4bfd-97ce-ad5479fc41de",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1bcf3d38-5706-476a-a74f-6c4b9c2e64e5",
"account_manager_user_code": "sample string 56",
"company_status_id": "2ebf3acc-cac4-40e4-bad9-f2db113bd271",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-05T06:05:21.0785514+00:00",
"id2": 60
},
"db_language_id": "bcf8217d-5b67-4e1a-8acc-fb547b6389c1",
"db_language_code": "sample string 7",
"db_title_id": "04c2762b-95ff-4d6c-9e24-37306dda9543",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-05T06:05:21.0785514+00:00",
"create_date": "2025-11-05T06:05:21.0785514+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-05T06:05:21.0785514+00:00"
},
"modified_dateutc": "2025-11-05T06:05:21.0785514+00:00",
"id2": 22
}