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": "ff32762a-8742-47ba-9f58-0568c09b1b2f",
"_parent_id": "3f6676a2-05e3-46c5-b90a-0a5f7fbfbc7e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "3c2870dd-95ac-486a-91fb-c8db7fd71c4f",
"company_id": "9553b33e-e1d2-4427-a796-ceefdb41f657",
"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": "5feffa94-766b-4262-bd69-321857486cc8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "245af5d8-e4e3-47ae-9aa0-8307b2be5072",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a015b153-a5d5-44c2-a348-b50781df1f53",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a4686b7d-72b2-495b-b047-9d3dfd7577f3",
"company_code": "sample string 5",
"company": {
"id": "cccdd8b3-db23-459e-b174-7e61c9886ad7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-15T10:17:47.0249895+00:00",
"sales_territory_id": "0651f58a-60ae-4371-930c-5bdf9c881a46",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e2b3b8b0-7462-4502-8db9-f3734dabcef7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "83b39ace-c1fe-4688-a355-faf0668f57ef",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0d3dfd88-626a-4c56-a232-f064a05b67a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1acc2b0c-4cc7-4f5c-b387-ae4086f256d7",
"db_currency_id": "f420bf2f-9b02-4f39-815f-bb7c5180b84f",
"db_language_id": "061fa8f5-f0a2-485c-a415-544bde1634de",
"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-11-15T10:17:47.0249895+00:00"
},
"modified_dateutc": "2026-11-15T10:17:47.0249895+00:00"
},
"marketing_segment_id": "04a1d49f-19b9-4ce3-b1d2-c285ec048ce0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dfed19bb-e8d7-4d9b-895f-848cd4908a19",
"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": "1e89b03a-dba6-449f-b1a1-5dbbb188d8ed",
"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": "b4912894-2ccd-43f0-bfe2-633e7c16296a",
"db_country_code": "sample string 28",
"feelist_id": "303f9f4f-8b76-4ac4-84f1-547c993f41b7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9c40d508-8917-446f-95e2-eba0762e71c9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e3e8cb73-f0e6-40ad-8378-c60df509ab69",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-15T10:17:47.0249895+00:00",
"db_currency_id": "07552380-5e34-471d-ae67-13061d7a5dcc",
"db_currency_code": "sample string 10"
},
"company_type_id": "8bbe9920-5661-49d2-ada9-554cf7695612",
"company_type_name": "sample string 32",
"company_type": {
"id": "6a84e29f-68ba-4780-acd7-b1b57150c9dd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "681b2c1a-aee9-4e51-8011-d7ff38fec471",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e4f31b92-4716-4f6c-8437-e8a97c15af85",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "97ddc443-9bce-4882-9f05-557241960ade",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2f4e95a7-3266-422a-97b6-c071bcec0c6b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7899024f-bab5-4370-8139-f28481908ca3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-15T10:17:47.0249895+00:00"
},
"company_sector_id": "57232b05-6b2b-4347-8d57-231059c10937",
"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": "3c7281e6-954a-4a89-924d-e10aef058845",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "983a441f-4a96-4097-ac03-70d04454cc46",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6960dfec-93a6-4259-b201-87f001edac5a",
"account_manager_user_code": "sample string 56",
"company_status_id": "969aa89a-6e53-44b6-94a8-74397faa0fd4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-15T10:17:47.0249895+00:00",
"id2": 60
},
"db_language_id": "0c71bf64-efed-46a5-a2ca-134d078e2a3d",
"db_language_code": "sample string 7",
"db_title_id": "031574bf-1ab6-4e0c-99a5-b0a3aa511e14",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-15T10:17:47.0249895+00:00",
"create_date": "2026-11-15T10:17:47.0249895+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-11-15T10:17:47.0249895+00:00"
},
"modified_dateutc": "2026-11-15T10:17:47.0249895+00:00",
"id2": 22
}