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": "9f0c526e-38e8-4aab-9e62-5a85f35c72a2",
"_parent_id": "b5671ec0-1f94-429b-b891-7d48d2550f86",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2d6ab4f9-253b-482e-9e93-2eb4fa79fc64",
"company_id": "e19a32a4-2558-410a-a156-c52e5c75454b",
"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": "3ecc08a7-88e6-43a5-b3c9-2bce7cfafa8c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "38e18201-e0d1-4681-82ff-66e78311c2de",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c9b94e7d-c389-4e16-a41a-f562bcd24d5d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "609c57ea-343c-4d99-8705-b87df06df78e",
"company_code": "sample string 5",
"company": {
"id": "36493efc-ef3d-4969-a3b7-e9fdf37f9b32",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-22T05:46:04.2855974+00:00",
"sales_territory_id": "4dd9d44a-888a-48c9-8509-7a36dae03e11",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d40f7b13-8efa-4972-b398-462f47ef6c00",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "699351a1-15e2-4437-a73c-4f68b60da3da",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a3534ea4-c586-46cb-b392-2511f2e2776a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8a28305-a10d-4c3a-8654-e7afc1fc2934",
"db_currency_id": "d2592717-946b-4a2b-a690-ba06031cc633",
"db_language_id": "d021410a-d0ee-4b72-9922-fa97da350e24",
"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-10-22T05:46:04.2855974+00:00"
},
"modified_dateutc": "2026-10-22T05:46:04.2855974+00:00"
},
"marketing_segment_id": "f79b4ebe-cc69-48fa-b209-8bda37fa2094",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7662a519-fd63-4552-8364-002149bfa491",
"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": "28314cd1-8b4a-4103-b1bb-aa161fed82b8",
"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": "794aea54-5352-4355-9d45-bc8df9e66734",
"db_country_code": "sample string 28",
"feelist_id": "115e78f6-6504-4d76-bb64-d9506c27b1dc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a06d793f-7d3e-49ac-ab57-13a44befa6a0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "610307e6-52ff-4a07-8a5b-55ff2d51994c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-22T05:46:04.2969498+00:00",
"db_currency_id": "6996137b-00ca-4521-8c85-cff914a348eb",
"db_currency_code": "sample string 10"
},
"company_type_id": "855fcf3f-4ac2-494a-917f-4421432e6e8d",
"company_type_name": "sample string 32",
"company_type": {
"id": "ac39079b-451f-4abc-9dda-6dc0130cdc61",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "680c9c82-71ba-4488-be69-e184dcd50180",
"sales_organization_code": "sample string 5"
},
"db_language_id": "af03b991-0bd6-499d-b66f-ec21c3aceaf3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "db91fc13-9c83-4fec-aecc-ec6bc2ab8bdd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "417e7001-f7d0-450c-973c-0d3e5806cf03",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5cc12e1c-5adf-4fba-90db-dedf26db86e9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-22T05:46:04.2969498+00:00"
},
"company_sector_id": "d97a534b-5049-4043-8243-f634945ccd31",
"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": "9465d780-a7c0-482c-abc4-7c6fd561849d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0877a9d4-ed1c-47d1-bbdf-db551a855420",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "80d3ab11-3f70-45bf-8ffc-0f56546847a3",
"account_manager_user_code": "sample string 56",
"company_status_id": "538f6177-f5f9-4a09-99ec-2e0e918d2e23",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-22T05:46:04.2969498+00:00",
"id2": 60
},
"db_language_id": "aa467e2f-adae-48e3-875a-5349bf8eaa35",
"db_language_code": "sample string 7",
"db_title_id": "864fbce4-6394-4573-ab8f-5031b76d4cf4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-22T05:46:04.2969498+00:00",
"create_date": "2026-10-22T05:46:04.2969498+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-10-22T05:46:04.2969498+00:00"
},
"modified_dateutc": "2026-10-22T05:46:04.2969498+00:00",
"id2": 22
}