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": "8bf1b59d-9483-471e-a875-f426eb0dd45e",
"_parent_id": "d1d5e3e6-dc9d-4736-9947-05ce3658839a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "cc43b45b-7fc3-4b98-9752-6ce8dc8cbc3d",
"company_id": "3bb5a398-ca01-465c-85ac-979372b37150",
"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": "3f40494d-ec6d-4893-83d6-49b98e54c72c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "138826a3-35c4-47a4-b92a-73fb542a398e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "556f3e0c-34c4-42ed-8198-0decd36d6ace",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6c0d1e66-3517-49bb-8817-328b0ca59f30",
"company_code": "sample string 5",
"company": {
"id": "c5fb2f81-20fc-4e22-ba71-3a5d379fe819",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-09T07:22:55.6895647+00:00",
"sales_territory_id": "d66ddab0-cebb-4516-ae2d-0172d9015de7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "18425fac-0272-4326-8eb6-8be9dcf900d1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9b7e5b95-64c7-4361-b150-f5217cbac806",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f9b1aafc-09c4-40a6-a533-8c0fb74a930a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "203f7e60-676e-4ddc-8268-4ecb9d8d146c",
"db_currency_id": "8fe1a09e-278e-45cc-b680-94e8868120c3",
"db_language_id": "26f87332-805b-4ebd-bb08-89ea49f4b971",
"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-04-09T07:22:55.6895647+00:00"
},
"modified_dateutc": "2026-04-09T07:22:55.6895647+00:00"
},
"marketing_segment_id": "4631ba53-81a3-4bbe-9a0d-1b34fe0b14ff",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "76c75ea2-f1a6-4002-b935-af74c19d41d1",
"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": "9f6c86b8-b484-4830-91fe-06ab7c94fc0b",
"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": "ee020bcf-2e36-4804-b67c-18ceaeb1c20b",
"db_country_code": "sample string 28",
"feelist_id": "36bf6747-5697-452f-9afb-e2d73ab3c060",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b445cb7d-3050-4320-afc6-b89960949f12",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "52295391-1cb1-41f1-a968-cb7f164014e7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-09T07:22:55.6895647+00:00",
"db_currency_id": "85641b95-ebeb-4ecb-a2b4-143c15d93a19",
"db_currency_code": "sample string 10"
},
"company_type_id": "e46a2ea5-4c2c-43e6-abe4-22a26b6ea306",
"company_type_name": "sample string 32",
"company_type": {
"id": "17ec1100-6f01-4531-9852-29e22d36944e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3df53224-baff-4863-bb2b-f533e89c7d55",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bed89d40-9ffc-4c57-9fbd-c7ffe10fcc34",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e138faa5-de20-47fe-9866-4f7ea5f68f8f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a7e4746d-12f8-4b0d-bdc9-9b706f3957d7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5b624bf4-ff93-432f-8cf7-d66bf8125a0a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-09T07:22:55.6895647+00:00"
},
"company_sector_id": "a1c24989-bbd8-4cf9-a874-990c1a1e41a1",
"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": "89f1b051-49b0-4eed-9307-18cc8ba6aca3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "656975f1-aaf6-4727-b42b-9dbe1cf844c9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ef26b7de-97f3-401b-a9d9-a9d1ffa9f263",
"account_manager_user_code": "sample string 56",
"company_status_id": "0c9b0d1a-756f-475f-a435-0488608a57b5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-09T07:22:55.6895647+00:00",
"id2": 60
},
"db_language_id": "897f2260-2274-4fa7-9fc0-9923ce522aba",
"db_language_code": "sample string 7",
"db_title_id": "4fc6078e-a151-42ea-852e-9d3e9439dbdf",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-09T07:22:55.6895647+00:00",
"create_date": "2026-04-09T07:22:55.6895647+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-04-09T07:22:55.6895647+00:00"
},
"modified_dateutc": "2026-04-09T07:22:55.6895647+00:00",
"id2": 22
}