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": "0326f44f-615d-4fcb-a771-a4af0083775d",
"_parent_id": "505eaa39-5c9d-441a-8f85-4073aa30d20a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "435312ce-8a71-4137-ac90-4f4b2217ffae",
"company_id": "433a1776-e10e-4de2-bbc5-bf541135f987",
"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": "e1d09d1f-165e-4dc0-921b-ceb70ba66820",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "9897457c-b32a-4ddf-b529-7644a21129e4",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "aaed5cc7-5742-49f6-acdc-5d7a2d4de807",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "67f07610-0cc3-4cc1-9c5c-807edcf1222e",
"company_code": "sample string 5",
"company": {
"id": "34443c33-3394-4e5e-ab2d-1fc356324700",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-07T20:50:29.1977053+00:00",
"sales_territory_id": "e6b3c213-5d0c-4f79-bb56-1bb1840b4d39",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9d0a8c23-306c-4251-aff7-efff2db5a9d9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0e51d66e-3004-4497-b744-2e4ee356c37d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bc5ae617-cd7b-405b-b982-ca587433f09b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ec17203-0214-4c22-8d2f-1492a36b4401",
"db_currency_id": "b03aba9b-0d5c-46fb-8865-585350122526",
"db_language_id": "50cc3a39-e47d-411e-9118-7e303f7fd878",
"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-07T20:50:29.213333+00:00"
},
"modified_dateutc": "2026-05-07T20:50:29.213333+00:00"
},
"marketing_segment_id": "bffd774b-c6f3-4cd9-ace7-262480af764b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "48a3d8f3-953b-4b61-a433-86dc3322370c",
"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": "34603c99-b30c-4cb4-b3cf-b5d81f5bdeb5",
"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": "835bd1a0-b9a0-438b-87ed-7728449df7b0",
"db_country_code": "sample string 28",
"feelist_id": "826e0ce9-42ea-49dc-9a88-4188622fbbf8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b9690fc7-0666-47a4-9490-363f2b7a6fc1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4ffddbe7-0209-4e93-b32a-c48890608003",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-07T20:50:29.213333+00:00",
"db_currency_id": "65934e82-4aab-4c43-8da4-b5a19d88f410",
"db_currency_code": "sample string 10"
},
"company_type_id": "f8981450-78fb-4b4d-886c-8116bfb23382",
"company_type_name": "sample string 32",
"company_type": {
"id": "c7846886-cadb-4aba-a99b-259a5ed16bbb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9738fd6d-4b66-44f3-a1ba-17bcb75b0c15",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c15fa122-64fc-4c14-a286-6888914ba1d3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "23a23b02-997a-4d4c-9899-174f603ff2a0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9cd07469-4806-4ab7-8807-bdf28d0c5c31",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d88e725a-f2c6-4018-a8f4-cc5f0897ec66",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-07T20:50:29.213333+00:00"
},
"company_sector_id": "afb16341-3750-4b38-adde-401d416fa9b0",
"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": "64f440de-bb3e-407f-a224-79d5437282f3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f7fe5186-b3e2-41ed-97f8-4872d52330eb",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "19407318-8f3b-44a2-a545-a8a82f91abe5",
"account_manager_user_code": "sample string 56",
"company_status_id": "f1ad8797-2538-449a-84c6-284ef16c27a8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-07T20:50:29.213333+00:00",
"id2": 60
},
"db_language_id": "689459be-b1ea-4f21-a876-af7c8a0a631a",
"db_language_code": "sample string 7",
"db_title_id": "9321d25d-e69f-4a70-becb-bcda956ad661",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-07T20:50:29.213333+00:00",
"create_date": "2026-05-07T20:50:29.213333+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-07T20:50:29.213333+00:00"
},
"modified_dateutc": "2026-05-07T20:50:29.213333+00:00",
"id2": 22
}