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": "cae7cda7-4897-4248-9124-e2482ffeae4f",
"_parent_id": "8d634402-0130-4726-a430-36a9457fc09a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e1e8b512-9799-4135-881b-501cb53ff2fe",
"company_id": "48d06cd1-44e4-46f6-80de-64580399b307",
"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": "14bf1a15-fdf6-46c6-905d-c2345d88ffb9",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "1858bfad-8275-47cc-8c8c-f8bc713d74ad",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "51c1ede0-853d-4f53-accc-f4c0142feb66",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "151b2ece-c3dd-405d-8da4-9751e28d85fc",
"company_code": "sample string 5",
"company": {
"id": "b7f33c95-6e64-4edb-acc8-1e8dbbcb59fa",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-23T10:26:12.931878+00:00",
"sales_territory_id": "a3652bba-4611-489b-962e-2873090de75c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7dae3e0e-618e-4f66-a5a9-6f3526336ca8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fca3a841-f4a9-47fb-98c5-1cd1a697ec07",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "714c0d85-e322-45cc-b13c-ff60c6c9613b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ddc34633-a3c8-417e-9c48-75632bc7b478",
"db_currency_id": "784cb0ae-4834-48bb-846a-064fb0959b4d",
"db_language_id": "6a3b04f8-67ab-425d-a061-5a6c38279d0b",
"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-05-23T10:26:12.931878+00:00"
},
"modified_dateutc": "2026-05-23T10:26:12.931878+00:00"
},
"marketing_segment_id": "36cfdc0e-9115-483d-9eda-12e34c38ea60",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e15a1002-c763-454d-a818-500695139087",
"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": "ca115dd5-7102-47af-b794-d533b1786f92",
"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": "33544cbc-bcfb-40e3-886d-0475d368701c",
"db_country_code": "sample string 28",
"feelist_id": "25759b84-3055-49fc-96b7-4acd0ac5cdac",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d737d7ba-1c2e-4493-b2bd-8ebc7361df6f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b98c91c8-5150-4af1-b0c7-ff35feb8ad96",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-23T10:26:12.931878+00:00",
"db_currency_id": "3c47ca06-9c7e-4477-ad7e-e44f9533130e",
"db_currency_code": "sample string 10"
},
"company_type_id": "7b2da735-625d-4056-91ec-d199517ce611",
"company_type_name": "sample string 32",
"company_type": {
"id": "59cc430f-afef-4f86-86ba-245b797d7cda",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a3b1bf30-3a5a-4921-8886-598980b89b33",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d2505ae5-4342-419d-beb8-b6c7ef25cb30",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e9f92939-1b62-424c-8812-f23c82d0d718",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b08734fa-4c65-4510-adba-c3edb329a29d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9f74a2bc-f91d-42cc-92c7-923dc50e6b37",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-23T10:26:12.931878+00:00"
},
"company_sector_id": "02b04db4-f028-47c4-8871-786aef82f365",
"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": "c55da29d-3aa7-45c3-b84b-ee0f879b7f0b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "dc058573-7266-48e2-9e4f-6cc79ecbff71",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ace425ea-fe53-46e8-bf97-73475debc86c",
"account_manager_user_code": "sample string 56",
"company_status_id": "88c5ca08-8fad-4b1a-8805-e790b2275991",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-23T10:26:12.931878+00:00",
"id2": 60
},
"db_language_id": "a01b4baa-284d-41dc-ad17-65d86cc94d9f",
"db_language_code": "sample string 7",
"db_title_id": "aad46a41-5612-4391-975a-6f87d743bc0d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-23T10:26:12.931878+00:00",
"create_date": "2026-05-23T10:26:12.931878+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-05-23T10:26:12.947502+00:00"
},
"modified_dateutc": "2026-05-23T10:26:12.947502+00:00",
"id2": 22
}