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": "1721b854-4710-47bb-b674-972e76ce1983",
"_parent_id": "cd3dc7df-db7e-4e57-bfc2-12c474b8857a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "29c7bfc8-6314-4fb2-84ea-79846e648a42",
"company_id": "c0e4a22a-d70b-4d5d-b01c-f980c63ee258",
"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": "12f758a7-7c64-464d-8e02-4f07ebcca76b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "af1dedd5-b937-4ff1-a0bd-899b6ff0ee54",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "32af9956-ec51-4d25-b649-ec4dd00583b1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b3042f88-9845-4cab-ab69-090016991b25",
"company_code": "sample string 5",
"company": {
"id": "ff7e7889-0ee1-4aa5-8c69-94911720318d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-15T17:27:53.2906737+00:00",
"sales_territory_id": "88d9655d-5b28-4931-b871-24ee38c3d9a8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "56e1308b-40e3-45f4-b32a-513a5a1a40d5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "171bdaf4-56c5-4fcd-8d8c-3ddba2db5285",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fb78c273-36bf-4ec9-b35c-6fe034867661",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f6df45ac-fc6e-42e8-9303-24d3b2a19a3f",
"db_currency_id": "198caa04-370b-424f-8b94-7e2a78a92903",
"db_language_id": "2d4f9b12-df65-4580-8ebd-ac5471676deb",
"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-08-15T17:27:53.3062944+00:00"
},
"modified_dateutc": "2026-08-15T17:27:53.3062944+00:00"
},
"marketing_segment_id": "3092accf-e1ed-42cd-9fc3-4a5b53f6131c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0076243c-b599-4172-a075-71b5b3710d52",
"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": "eabb6a27-8502-4749-966d-4f5d8a1b0ebe",
"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": "77a15e9d-a336-4e9e-b626-1fc6d675b491",
"db_country_code": "sample string 28",
"feelist_id": "ab97b873-3f97-46d2-bf0c-0281064bc1d2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d6cf5fec-03dd-44cf-ac7c-86391d7aa1f4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e3124ab3-dba5-48a8-bf5d-a5fe7541f2f7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-15T17:27:53.3062944+00:00",
"db_currency_id": "f0712d5e-35b9-44a5-8e67-d049be85710f",
"db_currency_code": "sample string 10"
},
"company_type_id": "28b06556-b2e5-41eb-80dd-7f88eea55096",
"company_type_name": "sample string 32",
"company_type": {
"id": "9e764e27-f00e-43b4-a4d7-f46558dac9f9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "67d04552-a6b5-4afe-84c4-68758973b403",
"sales_organization_code": "sample string 5"
},
"db_language_id": "19c47280-81d1-43f3-ac36-8e0b1b991646",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8922eb32-9a41-494f-ad5c-6a8501ed7791",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "43a4c7d7-8e22-4fa8-bde7-7ce321c33b30",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c7e50093-8476-4d76-a93b-154f1f3d19fc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-15T17:27:53.3062944+00:00"
},
"company_sector_id": "fa3fb47c-5112-4bfb-a7e5-39d57ada4934",
"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": "e080a8f7-9973-4ad4-9c20-77bb262eebd1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "119992b8-f342-4baf-b2c8-d688e052d80a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9648bfd7-0518-4981-8099-faf3dba3ef6e",
"account_manager_user_code": "sample string 56",
"company_status_id": "835674ae-8f01-4e29-a72b-125e5ebdc94d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-15T17:27:53.3062944+00:00",
"id2": 60
},
"db_language_id": "f97c37fe-118d-4744-87ee-dde2f5254480",
"db_language_code": "sample string 7",
"db_title_id": "171812b1-4056-488b-91db-0795181c2537",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-15T17:27:53.3062944+00:00",
"create_date": "2026-08-15T17:27:53.3062944+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-08-15T17:27:53.3062944+00:00"
},
"modified_dateutc": "2026-08-15T17:27:53.3062944+00:00",
"id2": 22
}