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": "c48acd51-3dda-4ae5-8b6e-96e9b31a97a6",
"_parent_id": "4e5c2c75-2fde-4e55-91ed-8c5c291e6de2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9dc95e0c-b16c-4e47-be93-ffe5685c4c77",
"company_id": "b6473a8b-c850-4c09-ae49-8505b1a14fd3",
"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": "6c033212-eeb9-4b0c-829e-d5f2b7fea63b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b58b35a5-3972-48a8-bc8c-a90153135e82",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4d2a455b-1f7f-4350-8cba-13a57fd22343",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "91031bc1-c664-44cb-a37f-5d4e85241c9e",
"company_code": "sample string 5",
"company": {
"id": "f552cf79-05f3-4bae-8ad4-d6d0cb3c267c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-16T13:44:01.1767431+00:00",
"sales_territory_id": "b8a25817-0f7e-4189-8b09-31c7026a96b1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0910ce4a-1e28-4b61-9640-0bf75e6063dd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "01ae8aeb-aaaa-4593-b444-cdebb60d3b0b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "73272bce-c155-417d-9176-fed5d1e35e8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1446b840-b9e7-4579-94bb-134007dc78d0",
"db_currency_id": "600e57a9-e43d-4f74-9511-16f2fabe9d2b",
"db_language_id": "c3c53f76-cd9f-4eb9-9d6f-ec56d51395fd",
"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-08-16T13:44:01.1767431+00:00"
},
"modified_dateutc": "2026-08-16T13:44:01.1767431+00:00"
},
"marketing_segment_id": "07a06c07-839c-46d1-88ec-0384f6c1adbb",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0f6db6b0-6f94-4f76-8e74-d143c81eecac",
"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": "c3be0355-6d2d-43e0-987b-89928d3c2f2d",
"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": "d56b1df3-d30e-4e01-b436-89388de0140c",
"db_country_code": "sample string 28",
"feelist_id": "5d70b9cb-c2e1-44fe-b535-ac4e3394b97b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b5aa70a8-6bf1-4035-bb42-819f99075e0d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0b9fa554-f8ed-47a1-bc87-4ce3ad3817e5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-16T13:44:01.1767431+00:00",
"db_currency_id": "6f6e14d8-8691-489a-88e5-8590324104d2",
"db_currency_code": "sample string 10"
},
"company_type_id": "058786d4-4eac-4108-b4d4-6d0c0d72754e",
"company_type_name": "sample string 32",
"company_type": {
"id": "eee3627b-b91f-4123-9a3c-ac20f8fce323",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7051c112-9381-4d06-a970-25071f44b268",
"sales_organization_code": "sample string 5"
},
"db_language_id": "074b1d1f-26d6-4504-ae61-940d586554f1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bda17f4a-4c9d-49da-bd3d-02db9e441015",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "641d8142-036e-46a4-b3e8-b399a417d6ba",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c5ef9b82-2f77-4ec9-8160-8625e8d3ce0a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-16T13:44:01.1767431+00:00"
},
"company_sector_id": "361645a4-a2e2-408f-a7a7-b597ecf48d99",
"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": "ce5b5ddc-cee3-4b48-b61e-d8f8c10315b1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "88f8c7ec-7110-4f78-b549-68873cdd49fb",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "09c6c6ee-99e9-47af-ac75-f1f733073564",
"account_manager_user_code": "sample string 56",
"company_status_id": "f403b58d-270c-4b15-b7ab-e070564a4666",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-16T13:44:01.1767431+00:00",
"id2": 60
},
"db_language_id": "d6f60f84-feed-430a-91d8-102dda6843e6",
"db_language_code": "sample string 7",
"db_title_id": "8fb8c0ea-022a-40f9-ad9d-81911d325edf",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-16T13:44:01.1767431+00:00",
"create_date": "2026-08-16T13:44:01.1767431+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-08-16T13:44:01.1767431+00:00"
},
"modified_dateutc": "2026-08-16T13:44:01.1767431+00:00",
"id2": 22
}