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": "9d908621-a86b-4df3-a306-e1c93ace05dd",
"_parent_id": "df993136-c8b3-4583-9934-0eaf0e736183",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "8be1904b-fe60-41cc-a90f-254a57963478",
"company_id": "500e70c5-fba6-464f-a343-f6ac694620e4",
"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": "3f494a13-8fb5-4a21-95dd-92cf66ea7e43",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a32ff450-bcc0-4050-b678-0087d6706f0c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "8c927509-62d9-4dea-a407-4818d119db60",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cc6acdaf-2594-44d2-85d3-31e867886da9",
"company_code": "sample string 5",
"company": {
"id": "c9ab1535-2914-4bec-9419-88502e2ffa85",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-07T01:40:15.0616907+00:00",
"sales_territory_id": "ab1ddfeb-48f8-4df7-a615-5b78a0012d09",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "eb16f831-5f18-4e6a-b7d9-1394f7257043",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "959952ac-8ceb-4baa-a93b-3fabe1673139",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3646d10d-a30b-48eb-b0ce-5687f5a6ca91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7915e958-a9b3-48ea-a79f-d7b666dade88",
"db_currency_id": "9f29e7e2-8bcf-490d-bc70-9eed2ff7b8a2",
"db_language_id": "b5ab4591-1598-4a8a-8fc8-c2746837220f",
"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-10-07T01:40:15.0616907+00:00"
},
"modified_dateutc": "2026-10-07T01:40:15.0616907+00:00"
},
"marketing_segment_id": "75e53af8-9d02-44d1-a19e-2b650169e04c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bdc749ef-f83f-4b92-bd89-138651c0942b",
"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": "305281cb-cf7c-44ed-906c-e577b37cf3dc",
"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": "6cb143fa-4f35-4322-ae93-107a01642ca8",
"db_country_code": "sample string 28",
"feelist_id": "13d07ec1-5e3f-4ac1-9ced-6055578e6a78",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "120fb959-8443-4e0d-8434-8acdcdeb46bb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3f5119ea-f65a-4260-8e46-67aed6ce05e3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-07T01:40:15.0616907+00:00",
"db_currency_id": "0beaef48-9135-4b9d-b12a-8a08d4b84643",
"db_currency_code": "sample string 10"
},
"company_type_id": "2a2c8bfb-e7ea-4bfd-9592-8be6bb0da8c5",
"company_type_name": "sample string 32",
"company_type": {
"id": "0b2b23a0-cd7c-4d29-a701-09f292426f88",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "621b43a3-7611-4bcd-bc35-f67c84a25610",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1134b208-c364-42fa-855d-04ad606bbae6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "22107c39-f0ed-4756-8859-0fba6e254e44",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e53dfd3c-06f9-4452-ba52-e1dcaeb808b9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6a5ba606-cb84-4813-bdd7-3d88010c2ac2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-07T01:40:15.0616907+00:00"
},
"company_sector_id": "9a3b8a58-bf9f-49de-98e8-62a8423016c1",
"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": "be318d95-bc0d-444c-ba1d-59d191d16adf",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f03eb677-910c-4432-9585-536080d96fcc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "15136f49-c801-486d-aa0b-d25bf1156487",
"account_manager_user_code": "sample string 56",
"company_status_id": "f0e6488a-d4c2-431d-aa3c-526b217a3957",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-07T01:40:15.0616907+00:00",
"id2": 60
},
"db_language_id": "7ea7469d-47bf-4922-9e22-52881e16b251",
"db_language_code": "sample string 7",
"db_title_id": "44c9a385-9ed7-41ac-b60c-adc2a675beae",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-07T01:40:15.0616907+00:00",
"create_date": "2026-10-07T01:40:15.0616907+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-10-07T01:40:15.0616907+00:00"
},
"modified_dateutc": "2026-10-07T01:40:15.0616907+00:00",
"id2": 22
}