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": "7172f4a3-34e1-4958-b2e0-7f2f71ffc43d",
"_parent_id": "5c2b37a1-f3c0-4f8c-a3ed-ad8e05ef0e58",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a5300144-0005-4926-9f94-03f95ca3d16a",
"company_id": "a4f6e8c2-298e-4c00-b062-d46920808a4d",
"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": "c202d477-99be-45fe-91f7-24918e7672b5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "8f07107d-dcd3-494f-bd8e-396882f392f3",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c1909047-80ed-4c26-9ec4-cb02bbbbce99",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "49667bc0-ac77-4f2e-a9dd-aa846d349444",
"company_code": "sample string 5",
"company": {
"id": "58d447a7-250c-4f80-bcf5-f93fe54baddf",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-14T13:15:56.217331+00:00",
"sales_territory_id": "02cb4fd8-cd75-4fab-939a-0eb8a67f508a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "26356b72-d669-4a4e-870f-707de0c96258",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1b43b95c-9632-4f42-96a9-81c11a090143",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e45909ff-f0e3-4019-bbde-f7c18bd5da7b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e522a11e-0460-47c2-9d62-a9a0cb1c908a",
"db_currency_id": "bb405dee-74cf-4f88-8a72-78e854e9fdba",
"db_language_id": "20171bf5-9455-4e87-a746-23ea2d5307dc",
"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-07-14T13:15:56.217331+00:00"
},
"modified_dateutc": "2026-07-14T13:15:56.217331+00:00"
},
"marketing_segment_id": "30508023-a6e1-4137-a717-e294a33da5e6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a2422d14-7ee4-450e-901d-223af0af1db0",
"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": "d601da84-4386-4722-9721-2a42128ba1bf",
"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": "24c45360-41bb-46be-ab55-78f8ab102427",
"db_country_code": "sample string 28",
"feelist_id": "70d9c100-7bd8-47ac-be52-f6ba961ec440",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2d396639-4528-46c9-a7bc-c88839617e9e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dbbda6d0-896e-40f0-9793-59b577be473a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-14T13:15:56.217331+00:00",
"db_currency_id": "14816089-7cdf-4375-bdae-de97bf986f0d",
"db_currency_code": "sample string 10"
},
"company_type_id": "b6adb3a7-f485-4915-ac51-b43a9c6f9117",
"company_type_name": "sample string 32",
"company_type": {
"id": "ae8033e2-c487-4afd-816c-f3b0d34e956f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c75217a7-8836-4e9e-a816-c7b1156abfaf",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c6f89225-0650-46a8-90dc-0c896bb05bd1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4b79341b-17e4-46aa-afa5-b99584d75a23",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "96222af8-39f2-47ee-bbcf-4ae4ea8bed39",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "68376116-b65e-4fd4-89d6-6709dbcab7c8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-14T13:15:56.217331+00:00"
},
"company_sector_id": "b3c1bcaa-1b43-433f-9481-2d243f0c8313",
"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": "4d7e21c2-985a-481e-b389-fdbcb75f06ad",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b6484fc0-c554-4fbf-b241-8629620bc31f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9270615b-40b6-43d9-90e7-51e435377270",
"account_manager_user_code": "sample string 56",
"company_status_id": "f089a005-2726-49a6-8ade-003b9171781b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-14T13:15:56.217331+00:00",
"id2": 60
},
"db_language_id": "8a3c22b2-3b8e-4c5b-b0d7-d6e5a1bb75bb",
"db_language_code": "sample string 7",
"db_title_id": "8f514011-de0a-46c5-b57b-a9d1490c083e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-14T13:15:56.217331+00:00",
"create_date": "2026-07-14T13:15:56.217331+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-07-14T13:15:56.217331+00:00"
},
"modified_dateutc": "2026-07-14T13:15:56.217331+00:00",
"id2": 22
}