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": "d65a3f82-2a74-4fe0-9565-ae972c66c1e5",
"_parent_id": "55aa4619-7cf5-4522-bd02-a0016d83cbb3",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2f5bee81-3013-43ab-a33e-9ce2218cd42c",
"company_id": "8b0a1d34-eef5-4e5d-b80f-625639eb6cd6",
"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": "b76097a6-9e81-4cc7-85a5-dc29ba3b4486",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "45f1a5a2-0b1d-4e67-abcd-dc10616d6e64",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "d1c23b81-a535-4749-bbd0-70f022aa821b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4c0d52a2-6132-41bf-954d-84e9378d618b",
"company_code": "sample string 5",
"company": {
"id": "e9e18c35-a2bf-4b8e-ad19-a568fc468239",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-11T13:42:56.5715776+00:00",
"sales_territory_id": "09f1a076-6489-4894-a96b-a74d9ecbd940",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a001100d-a3b8-4d76-b0d7-8c92374a2a52",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "17ae1f0c-a434-4886-8f6d-823915468e08",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5d723c58-9a7d-45a4-91c2-f706da0946b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "918323a1-7099-49d2-9012-bc15bc55d6f8",
"db_currency_id": "05098ed3-b47e-43a1-ae8f-07b0bee76f68",
"db_language_id": "99d32ac7-ccd5-4031-ad08-0013eadecc42",
"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": "2025-12-11T13:42:56.5715776+00:00"
},
"modified_dateutc": "2025-12-11T13:42:56.5715776+00:00"
},
"marketing_segment_id": "4a0b49e2-3509-4bfc-8bd5-96d07c70fc1b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "90707ff3-7615-4864-a95f-93e69526c528",
"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": "5c266f09-66de-44df-868b-b0450c80bba7",
"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": "82edbfca-89cb-43d2-bd18-e53547881e9d",
"db_country_code": "sample string 28",
"feelist_id": "feab0511-373a-4ca0-8061-86bfc7590f38",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "29b10072-6153-4211-8ead-1630b4c26511",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4c8aa370-b18a-4336-8cb4-d488e9399eeb",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-11T13:42:56.5715776+00:00",
"db_currency_id": "92413219-5ab5-4340-94ca-3443cbeda34d",
"db_currency_code": "sample string 10"
},
"company_type_id": "baf50857-9f78-423e-a79d-0f0901637d8d",
"company_type_name": "sample string 32",
"company_type": {
"id": "a0ad750f-37b0-4fae-a269-ec211e141d1a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4af25c1a-e619-4af2-a545-cf8d3cca3df0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c9688043-4647-4f74-a77c-fee6e7fe7da3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c3f934d6-dd83-4505-82c5-a0f5e720de17",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a13192bf-505e-4495-95b3-fc2063ad120d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e47f6b31-3865-4f53-84bf-55b551ed9e9f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-11T13:42:56.5715776+00:00"
},
"company_sector_id": "26ead922-5dd5-4a50-aee1-f1e8e2344f7d",
"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": "6b34e6f7-326e-4cfe-a9e5-938e1ee84c3f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a26f4005-be2e-4935-8679-d9507913620d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f26e2d8e-9691-4c04-8f61-b301f9aea455",
"account_manager_user_code": "sample string 56",
"company_status_id": "dfabcca8-c754-4756-8f67-4df70063d19b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-11T13:42:56.5715776+00:00",
"id2": 60
},
"db_language_id": "3b6f9886-3230-450c-acdf-dabf971d196e",
"db_language_code": "sample string 7",
"db_title_id": "22b18c97-7f58-4fc1-8bbf-dec890d2c248",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-11T13:42:56.5715776+00:00",
"create_date": "2025-12-11T13:42:56.5715776+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": "2025-12-11T13:42:56.5715776+00:00"
},
"modified_dateutc": "2025-12-11T13:42:56.5715776+00:00",
"id2": 22
}