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": "e10c83ed-64a3-4723-8436-466f3e159cde",
"_parent_id": "a58379ee-e617-4fa7-b369-da63f9b9d079",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c7476034-8a2c-450e-860b-df13779efffb",
"company_id": "19827185-3f19-495b-8d24-3f47d5aca271",
"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": "24de2a93-d0f7-4347-b840-fe092338dfe8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d0d7e844-e9c0-448d-b488-f770acd86edf",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "51ae5db1-8ef4-4b3e-9b30-901b7db38369",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0307d36d-8e6a-4f75-8113-19dcd7e9cc3e",
"company_code": "sample string 5",
"company": {
"id": "7bb924b5-e2b0-46a4-907b-ae808cd4d3af",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-24T08:39:58.4413712+00:00",
"sales_territory_id": "50d1b2c4-7866-4b35-9aee-42c2d616aa2e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "678be579-6763-456d-b281-bd538ebed57f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2c88a19b-5adf-4f95-b36c-bcb418002548",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8e11f148-2711-45b9-9785-de036ae3e570",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fc2f7f9-7750-4753-8c8d-6ebdbc7fefaa",
"db_currency_id": "221b09c8-e3d4-42c9-82e0-75a701d1498f",
"db_language_id": "5eabb7df-8ec4-4e47-9ed8-5fe3fe36f147",
"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-01-24T08:39:58.4413712+00:00"
},
"modified_dateutc": "2026-01-24T08:39:58.4413712+00:00"
},
"marketing_segment_id": "b3a14a09-b50b-41b6-9e7a-7a66f9d533b2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f9dcc3ff-3665-46d5-9eec-5d3ae3c6e113",
"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": "cbc8d02f-8236-4e81-9de4-2fa68452dfaf",
"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": "5bf25c53-79dc-428e-bc45-8a62c4b897fa",
"db_country_code": "sample string 28",
"feelist_id": "5853aac3-c80f-4cf7-974d-105c62005a40",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "306f61e1-457d-495f-86a4-26c8e5f11105",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "104d8f81-2df5-4747-8c10-afd6960ce6a5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-24T08:39:58.4413712+00:00",
"db_currency_id": "692fecd9-a986-4d7f-99c5-65b58a62e23c",
"db_currency_code": "sample string 10"
},
"company_type_id": "93c65998-2a6f-47ee-a1d7-35e21676f2d4",
"company_type_name": "sample string 32",
"company_type": {
"id": "77977033-b32e-4e28-aa15-7779fc64a4f9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fcbae694-f7c6-444e-a337-15dc364ea546",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1ad3cb53-205b-419c-9e70-ba519990305c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9cf4a8d8-ffff-4ed5-8e13-83a55d787830",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f27d7ac8-bc28-4650-96b5-44661c1ad4c1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b62f8ecd-a882-4889-80bc-c1014b2b34ce",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-24T08:39:58.4413712+00:00"
},
"company_sector_id": "2b0aa39c-93a1-4628-8ab1-59c61e85d570",
"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": "0abeb74c-ac93-4e40-b320-10e8d0bd0bef",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e5f31a99-398f-4f96-b5f0-4414aaeabed0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3077aa87-f185-4d85-a322-2088c530d542",
"account_manager_user_code": "sample string 56",
"company_status_id": "3961062f-9de9-4f89-9d53-76f4ed38c74e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-24T08:39:58.4413712+00:00",
"id2": 60
},
"db_language_id": "404d030d-ed3e-4f07-a967-42d39c76601f",
"db_language_code": "sample string 7",
"db_title_id": "f2ca8e01-a162-419d-8cf7-69a4b0db6c78",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-24T08:39:58.4413712+00:00",
"create_date": "2026-01-24T08:39:58.4413712+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-01-24T08:39:58.4413712+00:00"
},
"modified_dateutc": "2026-01-24T08:39:58.4413712+00:00",
"id2": 22
}