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": "5d85d529-9b6b-493e-8b2f-fd284594627c",
"_parent_id": "5243a31a-62e0-4222-a9e6-4d2fdd0c9efe",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "7758e669-246b-45fd-b287-c404f411f65f",
"company_id": "60f7a8eb-63b8-490e-948e-40d19a8df8f6",
"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": "21108b63-6be9-4bf4-9f61-ca1ad2ae5594",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3aa65f63-df37-4787-9e61-17e8a98f6457",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4d5c6402-c0b0-4bc4-9f71-6904237762b6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "07d5edf3-1863-4eef-9438-49fa0500c5c5",
"company_code": "sample string 5",
"company": {
"id": "868a5664-1852-4dcf-8663-78300417f0bd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-15T18:25:49.6985864+00:00",
"sales_territory_id": "850b31c9-8c6b-435c-81bc-78e1e93b0a46",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "635b6bc9-afeb-4e49-a217-8a17145e2edc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8b7297ab-26ba-49fb-817e-dfa9cdbe6334",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "50f75568-ee6e-4e3b-814d-e4aa78685b39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7530da8-c071-4d47-a32e-20aa2399f92d",
"db_currency_id": "1817c42c-2073-4d6f-9593-254602fa6cec",
"db_language_id": "e1fb0a3a-d3a8-454c-87b8-4c0ec3be8ea2",
"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-10-15T18:25:49.6985864+00:00"
},
"modified_dateutc": "2025-10-15T18:25:49.6985864+00:00"
},
"marketing_segment_id": "4aa15284-a513-4cdd-b0b8-c4809563f1ee",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fe8c844a-28c8-4c01-8f47-e01b9ab8996b",
"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": "a503ffb6-16ef-4267-a98d-04884cd2b62f",
"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": "2b8b1786-e372-495c-86bb-fd595038474f",
"db_country_code": "sample string 28",
"feelist_id": "5175effa-a775-4373-9dc3-979adba80aa8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "33b2708d-e6eb-44eb-8cf5-6ac77fa225ae",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "03b802e0-f13b-4f02-889a-954c8a8051df",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-15T18:25:49.6985864+00:00",
"db_currency_id": "b692a59e-9534-424a-a269-4c20a5781a6a",
"db_currency_code": "sample string 10"
},
"company_type_id": "14156450-227e-4db9-978f-7a24f3830ec2",
"company_type_name": "sample string 32",
"company_type": {
"id": "a38a8b33-fceb-47d4-af10-ae4a77b30061",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f9c7e9eb-2ed1-41cb-b1e7-4c4105c06e70",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ef254d99-b396-4fa4-bcca-50a8a19b2eb2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c6bc6c95-125b-4833-93d3-8d3cb4630f14",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c49dcf06-c2cc-4df7-a50e-e716741f91cf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "772dd313-f7a4-4f41-903d-d7c62752bac5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-15T18:25:49.6985864+00:00"
},
"company_sector_id": "3e7fe997-d44b-4d98-8a6a-7883d20e16e3",
"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": "b915ec35-95e3-49c5-99d0-017ab7ccd114",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0eb994b9-c986-446e-9e90-26e7644264a4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6bb75732-c148-46ee-a4d4-2f9435b4d2d1",
"account_manager_user_code": "sample string 56",
"company_status_id": "4fd57c88-28a1-4131-9e7a-6a7ac7aa0180",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-15T18:25:49.6985864+00:00",
"id2": 60
},
"db_language_id": "02891706-3f29-49a5-9d84-685eb89a46ee",
"db_language_code": "sample string 7",
"db_title_id": "bba34e65-92c5-4553-abea-c0565d84c0d4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-15T18:25:49.6985864+00:00",
"create_date": "2025-10-15T18:25:49.6985864+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-10-15T18:25:49.6985864+00:00"
},
"modified_dateutc": "2025-10-15T18:25:49.6985864+00:00",
"id2": 22
}