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": "0958ba43-32f3-4f58-b496-c1f0cd65d8a5",
"_parent_id": "a8f03cf8-f874-48c5-93e4-f1d328a2b325",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "7d62294a-5232-4283-972f-3d70053dc62b",
"company_id": "9649b320-aca8-461c-ad6e-21f4339b0064",
"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": "987a88b9-e717-46a6-997f-c8c364d6378d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0adeeece-4c95-4b9c-afa5-c98d53a1353e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "77c35c4c-6128-46a6-b16e-b1268ce9729a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bef1b1c6-c04e-4967-ac85-e0221533a1fe",
"company_code": "sample string 5",
"company": {
"id": "7192b7a8-d72a-4874-b268-2dc7a8211cb8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-17T10:09:44.2948969+00:00",
"sales_territory_id": "b3ea443e-6d49-4687-b251-7c3afd1d44aa",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "61f64a31-a49d-4a19-b47f-356dbb0594c7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e4090449-5a9f-4784-bb26-56ca0d47eda6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d827652a-f7a7-4688-8948-027973843a3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8f1f1dd7-c24d-4bd9-8bbd-7bfddebd950f",
"db_currency_id": "3d7b21c0-3d31-4204-952f-1d6bfc70dec2",
"db_language_id": "4af50b7f-d27c-41da-b4eb-8cd99203ebf8",
"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-07-17T10:09:44.2948969+00:00"
},
"modified_dateutc": "2026-07-17T10:09:44.2948969+00:00"
},
"marketing_segment_id": "9ca9afa2-62f5-49a1-84ee-404d348faede",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c2115207-55a5-46e9-9261-c4a4e6b2c9a0",
"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": "b710eea6-a127-41d1-8920-32636ca2a3d3",
"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": "2a058bae-c1f2-4a16-87aa-eb4ad6808e92",
"db_country_code": "sample string 28",
"feelist_id": "e8c3c4ad-8e9b-41a5-a986-eb985d711c63",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8f8453c9-c015-41a7-92c7-6bd4fcbf70e4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "44533533-008c-48a8-a120-b786c28eee0b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-17T10:09:44.2948969+00:00",
"db_currency_id": "92bdebe1-f847-47d0-8abe-a4c46b164353",
"db_currency_code": "sample string 10"
},
"company_type_id": "103c98fe-fb1f-4c49-bf18-f653f6eaba68",
"company_type_name": "sample string 32",
"company_type": {
"id": "5a1d72a1-d496-4143-a10f-a971916c0b38",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "77616dea-3d48-407e-b703-4cfc92139738",
"sales_organization_code": "sample string 5"
},
"db_language_id": "21722f0a-693d-4da6-944c-6b4064a59454",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "08266d05-d9f0-4eb1-a018-741b36b51ea0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1791872a-604b-4012-8b03-ee75eaa7fe47",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9a5373cc-ec75-420c-99ca-4e6daafbf17b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-17T10:09:44.2948969+00:00"
},
"company_sector_id": "efda84e8-8016-4f51-bab0-f3a270b3f1d1",
"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": "055f06be-15cc-4b49-ab7a-6ff84b50c1aa",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "542e2535-f063-4266-b07f-6c731f281800",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "01059997-3dd5-449b-ae99-ddd0ea5bb6ea",
"account_manager_user_code": "sample string 56",
"company_status_id": "c4238596-442e-4fb6-af8a-78c12aed0c51",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-17T10:09:44.2948969+00:00",
"id2": 60
},
"db_language_id": "b1349ee5-c2af-4b5d-8ab2-a6364e0ac6b0",
"db_language_code": "sample string 7",
"db_title_id": "e9b83b43-48fc-469c-a311-884dab1c9caf",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-17T10:09:44.2948969+00:00",
"create_date": "2026-07-17T10:09:44.2948969+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-07-17T10:09:44.2948969+00:00"
},
"modified_dateutc": "2026-07-17T10:09:44.2948969+00:00",
"id2": 22
}