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": "f77ae297-eab8-45e2-85ed-be7bb4722846",
"_parent_id": "e005625c-ab4d-4f2c-95b9-7540672dd81d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "74c0f311-bca2-4c6d-9723-17ccc9c3e169",
"company_id": "0b3bd881-9413-4a63-b4bf-7eaaf8c6f63f",
"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": "719647c8-da1c-4cb0-aafe-cc566946c651",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6d1b8cb8-b2e7-464b-b1e0-b092589c7457",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "64ec001e-ecf4-49a2-a3c2-d9552d9f61c7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dc280d9b-b86f-49b8-acd0-338cb9b0ab66",
"company_code": "sample string 5",
"company": {
"id": "589b1396-ab6c-448f-accc-4b9a4de7c8ca",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-27T13:03:57.4556933+00:00",
"sales_territory_id": "9676f5e4-852c-45ee-9ad9-04fc387e2032",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "adcad262-a8d0-405f-a0e3-3b6404503493",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b03d77b2-6f38-43de-9dfb-dc1301952830",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7cd70123-c2a0-42ef-a8a7-e9e5d9379413",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b923d5f1-f961-412b-b54f-ad4dbcbbf91a",
"db_currency_id": "60e7b38c-1412-4595-aa00-20571e44494c",
"db_language_id": "ca5cc57c-a7af-431e-af7b-8fa935532a82",
"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-27T13:03:57.4556933+00:00"
},
"modified_dateutc": "2026-07-27T13:03:57.4556933+00:00"
},
"marketing_segment_id": "cb3a656e-9cf7-43bd-9289-3b69f17585b9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "043cfd5e-84ce-40ec-8142-8c6a9192ef70",
"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": "20bd3dc1-f5ff-4e2c-bafb-33d75017370f",
"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": "f0dabe7f-c5b9-47f0-b2fb-ecb7aad69cd9",
"db_country_code": "sample string 28",
"feelist_id": "7f6171e9-8398-4f2d-89bb-2b0c063b5848",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0bd314bb-f4f5-4fe9-95cf-e515023e1524",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "50fe0b36-9ddc-44d6-b949-740b095ccdf2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-27T13:03:57.4556933+00:00",
"db_currency_id": "7ac3ff89-f4c8-4276-8114-1a5ba702c1f9",
"db_currency_code": "sample string 10"
},
"company_type_id": "be87444b-c26d-418a-bc58-22a82a8137ba",
"company_type_name": "sample string 32",
"company_type": {
"id": "61fba27f-56ab-47ce-84ad-781b110464ea",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b9910681-18b8-4796-b5ab-0d94602569c7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "123db78a-822d-4283-a1d5-9a80a1b70c71",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0a0c4bad-d078-4a50-b2f9-6eb371e7339e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "92421e83-63ca-4fa4-ad48-f90ef08973d3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c3ff9a8b-8610-47e6-90b8-5336621677e6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-27T13:03:57.4556933+00:00"
},
"company_sector_id": "a3f0cf9a-e117-4aab-9eec-17e9c5c5cb6e",
"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": "45478151-931f-44e4-9a35-e779758178f8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4651ed0c-ee48-48dd-bcdb-055ec49ba0da",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9247ba18-398b-430e-add4-4030b131a655",
"account_manager_user_code": "sample string 56",
"company_status_id": "433c174c-93d8-4cc3-8075-118cc7089d48",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-27T13:03:57.4556933+00:00",
"id2": 60
},
"db_language_id": "1c755e1e-c86d-488c-955c-f487ff68eca6",
"db_language_code": "sample string 7",
"db_title_id": "c32dfed8-a516-49f2-96ae-e1d2b0425216",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-27T13:03:57.4556933+00:00",
"create_date": "2026-07-27T13:03:57.4556933+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-27T13:03:57.4556933+00:00"
},
"modified_dateutc": "2026-07-27T13:03:57.4556933+00:00",
"id2": 22
}