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": "08deb52f-ddae-4243-837c-30c48e7c19c7",
"_parent_id": "c60276c7-7f3e-4969-ad24-add3db1da065",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "4c66e0ee-386c-4306-a3e3-87292826f2bf",
"company_id": "9caf63bf-399a-4c9c-8974-a6ba0c720bcd",
"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": "49f3101b-a98a-4286-bae3-836608f4c560",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "29b8fdb1-6654-45d5-b56b-3a13e89308a6",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2df71e96-df94-4c50-9979-43f8fd1eead9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ffbf4f60-12c6-4891-a6e5-6b1239d44f3d",
"company_code": "sample string 5",
"company": {
"id": "158bfdb3-33c7-48c4-b85b-6c6c7c2dfc85",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-09T08:47:19.7346796+00:00",
"sales_territory_id": "41a38a3a-07a9-4b30-903a-a3e1a0db902f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "756b8f1c-d2fe-4b35-ba58-113de38bb811",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c2a9d669-805e-4baf-93b3-483cb9295840",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "108418e9-8bf9-495c-9f49-bc77397e5097",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ebbe2568-5fa4-4887-91e2-78a98ae06574",
"db_currency_id": "981ba4de-527c-46e3-9101-190c3dd14714",
"db_language_id": "0a93e42c-3bf9-4be3-af5e-3af10f48eefb",
"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-09T08:47:19.7346796+00:00"
},
"modified_dateutc": "2026-11-09T08:47:19.7346796+00:00"
},
"marketing_segment_id": "509dfb4e-075d-4397-9ea1-88d4bb3233e4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7d8c7a4d-507c-4a9c-8036-57dc9dd2717f",
"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": "37d9010f-2212-49b9-afc7-8b4d105e3dc2",
"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": "756f234b-f91d-4054-a615-86c8dd72567b",
"db_country_code": "sample string 28",
"feelist_id": "44a91b4f-59fe-498f-856a-16deae89a3bd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3302347c-72cd-42e2-9897-0ca5eeece33e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "507b1405-7851-4b51-8513-1fe91983154a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-09T08:47:19.7346796+00:00",
"db_currency_id": "2108517e-7064-44db-b12d-aa82a6be1a3c",
"db_currency_code": "sample string 10"
},
"company_type_id": "4c4400ec-d1af-46c3-89e4-5e5e52600758",
"company_type_name": "sample string 32",
"company_type": {
"id": "8534b170-98ed-4338-beab-65723bcc3e37",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5add4c07-5a1e-47b2-b27c-a7cd8ef42080",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0b915170-fd38-46a4-9449-e518bb4d5ab0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dc4f1f71-89a9-4b69-95bc-201e98795f00",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c373c4f5-63bd-4dbc-b552-3e071dbd05df",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "20489e18-924d-44d1-8e78-5088ce5f9d2d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-09T08:47:19.7460483+00:00"
},
"company_sector_id": "9e4d3c1c-9e4c-479a-abc6-55c022d5522d",
"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": "f9d9792a-9b93-4f3c-be6c-5c7f25ce3957",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "30249f6a-b760-421c-93f1-a5d4272bfae4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5534605c-738a-4d6d-80df-a6b373490f7c",
"account_manager_user_code": "sample string 56",
"company_status_id": "fc98da35-455d-46f6-9f78-bfe5fa4eb4c9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-09T08:47:19.7460483+00:00",
"id2": 60
},
"db_language_id": "b3592650-e050-43cb-b720-00e61b11cab5",
"db_language_code": "sample string 7",
"db_title_id": "786d710f-2130-4a9a-b2d8-ba01a315bf24",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-09T08:47:19.7460483+00:00",
"create_date": "2026-11-09T08:47:19.7460483+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-09T08:47:19.7460483+00:00"
},
"modified_dateutc": "2026-11-09T08:47:19.7460483+00:00",
"id2": 22
}