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": "fc51aaa5-abac-42c7-814b-8f00f57d4cb9",
"_parent_id": "f34bcc2c-92ac-4f96-95d0-73b6139b2241",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9b237c54-344d-4539-a448-a5244420cebd",
"company_id": "e33434ea-d95b-442b-aa50-8673169ccfbc",
"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": "70631949-bf9d-4f6c-a6ee-41f1e2807b14",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b384d8a4-15fb-4061-b066-cc6215c437d1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "abc84df4-d5ef-4d60-926c-8f15616e7751",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "753751e6-8775-49d0-bfe0-ffa79c3b8ffb",
"company_code": "sample string 5",
"company": {
"id": "70a01432-1572-43ab-bbff-e79c1d2798bc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-17T14:02:03.851553+00:00",
"sales_territory_id": "3000c516-585a-478f-829e-8764333f12ee",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "87d31934-ac38-4471-9485-29a26f45ddd6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "892df07d-744d-4e1c-b608-4fa0476fefe1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f1286293-42f0-4f18-8f9d-a11fc3dbf800",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c8896f3a-a181-46d6-9e17-d4cee8db93ec",
"db_currency_id": "00f23e06-13c0-426d-9ad8-82072f215fd7",
"db_language_id": "f2d533ab-605a-4554-9c17-b8d1aab02364",
"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-17T14:02:03.851553+00:00"
},
"modified_dateutc": "2026-10-17T14:02:03.851553+00:00"
},
"marketing_segment_id": "c8875315-8200-4ff2-8323-6c97111abdd4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "315e0eb5-08d7-4f82-a0ad-01d85c8f571c",
"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": "a7fd242f-4ac1-4b59-a32f-b324a1ae3565",
"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": "194ad926-275a-4d95-bba6-217fd7be2ecc",
"db_country_code": "sample string 28",
"feelist_id": "0719e2f0-81f7-49a0-87f5-84a30793a4fa",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "322a6a05-fa11-46e3-8629-a17cd63fb8f9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "50dfa2f6-578c-40eb-acba-3b57bb846e2d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-17T14:02:03.8687412+00:00",
"db_currency_id": "7b303980-ae89-4284-816d-2bdfcf248d0d",
"db_currency_code": "sample string 10"
},
"company_type_id": "e587d27f-27b1-404b-8bd0-0745f761b9ba",
"company_type_name": "sample string 32",
"company_type": {
"id": "544c7439-cf2d-4466-8373-21ede1bbab05",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "624897f3-b64f-4f0f-ab12-c0095b264850",
"sales_organization_code": "sample string 5"
},
"db_language_id": "33521520-73c3-42db-8658-a031e0d57a85",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f649fe63-235e-4a16-b7e4-c016c1520fda",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "13fd8d08-3ff9-4e7f-bead-068de2b4b231",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "29fff7d3-bdb1-4bfd-96a3-4a3227b9b109",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-17T14:02:03.8687412+00:00"
},
"company_sector_id": "93e852b4-e12b-4890-8de7-1a8b7b89a721",
"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": "b26d3d3d-d467-4aaa-b112-21b2afcde726",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "975a1415-1bad-4cd2-a38b-a3d8983728a8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2a78772c-b086-4b0f-9d8f-e2de33b44520",
"account_manager_user_code": "sample string 56",
"company_status_id": "7b9fdc17-e2fc-421f-a498-ea0d3f4afc04",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-17T14:02:03.8828019+00:00",
"id2": 60
},
"db_language_id": "32515383-ea4e-49b1-ad4d-9652cc1bb8ee",
"db_language_code": "sample string 7",
"db_title_id": "0a403ed3-b098-4ec3-9121-dde5c519ee8d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-17T14:02:03.8828019+00:00",
"create_date": "2026-10-17T14:02:03.8828019+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-17T14:02:03.8828019+00:00"
},
"modified_dateutc": "2026-10-17T14:02:03.8828019+00:00",
"id2": 22
}