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": "91facd05-3fd0-45d3-950f-95b9462f3b27",
"_parent_id": "6f45c1e0-d02a-49d0-8a4a-1a4dbf1d016e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "0b56ac2d-da93-4509-b92c-284c4d26a47a",
"company_id": "444ca035-bde2-48d7-97e9-9d7822c49790",
"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": "63136a05-8dd4-42fb-b77b-88cbdedd3638",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "280a0a21-9234-4003-b814-17ebe71e39b2",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ed9eac85-984d-448e-a9f0-347fcb857838",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "84950edf-5915-4b42-89d6-e9618ca874a0",
"company_code": "sample string 5",
"company": {
"id": "bca5c44b-651a-4551-b78f-070dbc063b4f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-21T18:25:59.0012447+00:00",
"sales_territory_id": "3b621a4a-f3ac-4273-8fc9-11be1e9d63dd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a070c4c6-2ecf-47cb-aa17-3eb72d8d3771",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7b94a4d9-2eca-4b09-89c1-2f9a6c3f4905",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "20cabe1d-afca-4576-a418-0fc4256e7644",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b3e20bc-0fda-4ae2-aab3-36b34f3ec74f",
"db_currency_id": "10ecfaa8-0db1-4a7c-b85c-e61d535779b5",
"db_language_id": "ed52b09d-dacb-430e-a44e-63d5f30cf9ed",
"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-09-21T18:25:59.0012447+00:00"
},
"modified_dateutc": "2026-09-21T18:25:59.0012447+00:00"
},
"marketing_segment_id": "3169886c-30fb-4549-8033-5c60ab224822",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "17a8c9f1-2ffa-4043-85e2-9694feb0cbea",
"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": "28b1e0e8-2b4b-42f8-a394-5510ff6262fb",
"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": "aec32b20-b79d-4ac2-bf48-2757cdc1121b",
"db_country_code": "sample string 28",
"feelist_id": "7eeb6f51-f7c0-49b6-9b4c-7b55acb53619",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2286bc86-d109-4898-96ad-fa9be575bcfb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "85cf80ce-8907-4306-a638-907ecf611887",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-21T18:25:59.0012447+00:00",
"db_currency_id": "2865f109-9bdd-411d-81a2-4d4efc72b408",
"db_currency_code": "sample string 10"
},
"company_type_id": "9b0d6bd4-5b9f-4a8f-9a9d-95232e2bb972",
"company_type_name": "sample string 32",
"company_type": {
"id": "0891844f-12bb-423a-9a18-2367a58bd348",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c6c4d4a7-d082-4139-b656-d6ef4d406a36",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5c8a16c8-3230-4510-9c5e-37f15b12be96",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7bed7283-9fa5-48b0-93b3-a9f0e9a17c0c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "31fa36bd-42bd-454d-bf73-b7ed97aff71e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "36582d19-d260-45bd-b516-7a023d98c90d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-21T18:25:59.0012447+00:00"
},
"company_sector_id": "ab715c7c-9422-4f8a-9d66-a16ff03647b0",
"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": "2372e1b9-13e1-4232-8363-50baf8282131",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7a4c1dd9-2486-4f6f-811d-8195bf55accd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cd79afb6-ffda-47e7-82ec-3e076ba430e3",
"account_manager_user_code": "sample string 56",
"company_status_id": "20e34fe1-fc44-4991-a69e-4221a5f54a0e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-21T18:25:59.0012447+00:00",
"id2": 60
},
"db_language_id": "f53c08b8-f036-43b6-bda0-15223c37680d",
"db_language_code": "sample string 7",
"db_title_id": "2c84b65b-d689-491c-a191-e496f695fd6b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-21T18:25:59.0012447+00:00",
"create_date": "2026-09-21T18:25:59.0012447+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-09-21T18:25:59.0012447+00:00"
},
"modified_dateutc": "2026-09-21T18:25:59.0012447+00:00",
"id2": 22
}