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": "61db89bb-5e3b-4749-b6d6-e864fe06556b",
"_parent_id": "94e9b0bd-091c-44cf-939e-d335d7f9d4f8",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "999ea72e-418f-4df4-9bab-ea44b6a8946a",
"company_id": "65d89469-3e7d-44a5-9a1e-51dd463df467",
"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": "9aa2b7d7-e921-4deb-b4c1-375c9254add0",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "1e222086-1835-4a9f-b328-675bc5214985",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "bd35cebc-6ad7-4230-9ae2-347f140266a6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "56603988-4562-47e9-9723-63ec05d1d130",
"company_code": "sample string 5",
"company": {
"id": "f30dfdb1-2f97-4b27-9cdd-6738ee9fc43e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-28T06:10:08.8945209+00:00",
"sales_territory_id": "c056a371-b30d-4234-a33e-55d7b1084e69",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "afb1cc59-7ce8-417e-bc04-458bcbfbde7e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ff1d76fc-2393-47ef-a7be-2f305eefcbb4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "da96a980-44fa-433e-a2f3-3c8bdf45d65f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b94e9dad-cf94-48dc-9947-a40a2851e195",
"db_currency_id": "48ee9a8e-a05b-4408-b942-984d7c69ffba",
"db_language_id": "b50b6dd2-0be8-4e31-aa15-75b38c506a51",
"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-06-28T06:10:08.8945209+00:00"
},
"modified_dateutc": "2026-06-28T06:10:08.8945209+00:00"
},
"marketing_segment_id": "04dd1e9b-4de3-4116-8ae1-3aa9ebc6a167",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "60195bdd-2612-4644-a356-2f70d775d424",
"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": "cb2b4d05-d3fc-4bff-abb1-40276d83ed95",
"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": "47f3e633-2445-4f33-8232-cc426ff3255b",
"db_country_code": "sample string 28",
"feelist_id": "73183872-f9eb-45b4-bac4-b9b465ffa802",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "34b2eac3-3816-40fa-889f-4e4a25113710",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1a012892-7c9e-45bd-900a-b993e1c496fa",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-28T06:10:08.8945209+00:00",
"db_currency_id": "9d495e61-3de1-4ec3-840a-278ce4cf5fe6",
"db_currency_code": "sample string 10"
},
"company_type_id": "5387142e-3cf6-42a3-bf0d-1e699d9efbae",
"company_type_name": "sample string 32",
"company_type": {
"id": "872f3176-1226-4a08-aa82-0a4779d25325",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2fa8d421-274f-4dfc-8abb-e1f0b9426e83",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f21b3f48-a2bf-4b7a-b136-6a461a7d8b5c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "77746976-bbdd-4e1e-b2da-0660385f36e7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b95bf472-cc9c-488c-9811-9e52919c9529",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e2e9c21d-816a-476b-8f0b-fdf99d33a0ef",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-28T06:10:08.8945209+00:00"
},
"company_sector_id": "db822189-c55b-4e79-8dde-61ee0723b38b",
"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": "c71dde38-ee40-49ab-a01c-c235ca61d335",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0020cf99-1a98-418f-b71a-3db5a9e4caa6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "68c17e70-7202-4cea-8714-136e24b43baa",
"account_manager_user_code": "sample string 56",
"company_status_id": "0431645a-acce-4a7d-97d2-75919b52ffe1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-28T06:10:08.8945209+00:00",
"id2": 60
},
"db_language_id": "6eea028a-f25a-4bfa-83d5-3c7deb4d3b9e",
"db_language_code": "sample string 7",
"db_title_id": "b024dfdb-5662-4c68-89ec-26a9c2ccb905",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-28T06:10:08.8945209+00:00",
"create_date": "2026-06-28T06:10:08.8945209+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-06-28T06:10:08.8945209+00:00"
},
"modified_dateutc": "2026-06-28T06:10:08.8945209+00:00",
"id2": 22
}