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": "92b9127c-837e-4802-8aaa-256c96add3f5",
"_parent_id": "eb1c93a6-b41c-4324-8729-699564a67ce3",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "95453b3e-3117-4318-bbcf-e431140f0dd0",
"company_id": "ace1bc18-9c50-4098-9f4b-8e1877bf46e7",
"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": "bcb497f3-f943-498d-a2e8-0fb016273b44",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d70a5f23-7846-4f41-be14-9a2c56181121",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "8c6496b1-344f-440e-80a4-1e29257daf63",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c9c97e6e-e243-42cf-8322-2284ae5d22df",
"company_code": "sample string 5",
"company": {
"id": "29fe2c71-14bd-4a3d-95ae-02222533605e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-14T17:13:05.6681855+00:00",
"sales_territory_id": "9c35ae75-cd60-4d31-94d8-749bfed33001",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0dd911e8-55c7-4399-a5a0-8bfdf92bb11c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "42586643-c1e5-4b79-a4ea-1a211b5e00c8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "267edb08-075d-4a5e-b9fb-866fb1b80848",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e849fc93-9115-4915-a08b-2fc0544da41c",
"db_currency_id": "818b2e97-c16a-4e6a-ac39-1de7f55ca2c0",
"db_language_id": "14717145-e58b-435a-94bc-511524ce0ca3",
"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-11-14T17:13:05.6681855+00:00"
},
"modified_dateutc": "2026-11-14T17:13:05.6681855+00:00"
},
"marketing_segment_id": "cf7ed3d0-06ce-4bc3-b57e-cef24caa6bc3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "efe4cea6-95d0-4c8e-8b31-5b07bccecfb8",
"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": "ee7dedd8-3938-4599-9339-d434c6dfc4d3",
"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": "0b9242d9-01a3-4123-b4ff-24a3a4ac0661",
"db_country_code": "sample string 28",
"feelist_id": "c36d559b-f1f1-4ddf-98e0-3068b6c1cead",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1dc88b43-78ee-48ca-92ab-e6c37429bc00",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "629a7554-b30b-43c7-933c-4541544e66f6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-14T17:13:05.6681855+00:00",
"db_currency_id": "9e4cb628-f062-4d61-91d2-7981f9b44662",
"db_currency_code": "sample string 10"
},
"company_type_id": "0ac69f9a-3329-4802-b57e-3120e12e98f1",
"company_type_name": "sample string 32",
"company_type": {
"id": "b014fbc2-cfa4-4374-81e5-28ea7580a3c6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ac26a9e6-6185-40d6-937f-14d303548a62",
"sales_organization_code": "sample string 5"
},
"db_language_id": "da065a54-c27b-482b-b740-e72cffcc550d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "aae91ee3-83bc-4dda-9503-5bcb170aad0d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "45bced4f-4158-48c1-bec0-dcfcdee1ce30",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f9f6169d-c2da-448a-831f-75e806e30aca",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-14T17:13:05.6681855+00:00"
},
"company_sector_id": "b30769e2-18b7-487a-9f35-4559445606ac",
"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": "62f6ce3e-dc7d-471c-92db-366e4f252948",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "69063cfd-beec-42d5-a631-3f456b78b9a1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "48fab2ef-4dc5-426d-8894-73dc9cf63c1d",
"account_manager_user_code": "sample string 56",
"company_status_id": "2f243c0f-f86e-4dcb-ad5f-6a8d16f61709",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-14T17:13:05.6849755+00:00",
"id2": 60
},
"db_language_id": "906cd748-8e31-4f87-87ce-84d8db8cf4e9",
"db_language_code": "sample string 7",
"db_title_id": "673d7b60-247b-442e-b5bf-a4e7661244c8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-14T17:13:05.6849755+00:00",
"create_date": "2026-11-14T17:13:05.6849755+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-11-14T17:13:05.6849755+00:00"
},
"modified_dateutc": "2026-11-14T17:13:05.6849755+00:00",
"id2": 22
}