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": "4b379192-6d3e-409f-b97d-06670ce4403d",
"_parent_id": "287e2ced-27a7-4188-9c58-4e65a7d3a4ff",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "3e99ca57-c71f-4efa-8bd7-29fe0b74ce4b",
"company_id": "60590ea4-31bd-44aa-bc9c-1d18492efa85",
"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": "f4935f75-11c9-460a-8274-b1e3b57321c3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "cfa36a61-022f-4d77-bcd5-5c3edcc36f66",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "cf37956d-5201-48e1-9295-56ec35d0e145",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6ec25cbd-6a96-43e3-868a-6e59f0764b8a",
"company_code": "sample string 5",
"company": {
"id": "2427cb2e-dd5d-4bbc-ac78-048c7ee1acde",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-18T02:58:47.3925723+00:00",
"sales_territory_id": "32c0c22a-7f19-4c48-9d3a-f7768c7789e8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c02eba3b-82f0-4f12-9883-e42353be900d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2c6cc5c0-e0af-4af7-8acb-f0d01dfc1b0e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5ffe310f-6e45-4d29-ba1c-b56e49f5ea4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af4e9176-cfc4-477c-8381-ae711bb4cb2c",
"db_currency_id": "c1c78e43-c6a8-4b56-90cf-ef66c3ff08ab",
"db_language_id": "245f277b-d540-4536-8c99-3f7468ba9c0b",
"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-18T02:58:47.3925723+00:00"
},
"modified_dateutc": "2026-08-18T02:58:47.3925723+00:00"
},
"marketing_segment_id": "d04c7622-9fdb-4f1e-96ac-a4fc91993231",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dda666c3-8f01-45cd-a0ea-57a8607fb4ab",
"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": "7b687bc5-b586-4d9e-abbf-f257faa9df2d",
"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": "3a66cf38-afed-47de-a01e-826b64e218dc",
"db_country_code": "sample string 28",
"feelist_id": "bff59f2b-57bf-437f-81b0-8edf7097f114",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9606994b-0dc9-47f2-807d-38e3cacab2bf",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b93b7361-90d9-4829-9624-94b7e1652580",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-18T02:58:47.3925723+00:00",
"db_currency_id": "7a93cbfe-e561-474a-aa71-0cb7fae55868",
"db_currency_code": "sample string 10"
},
"company_type_id": "b04d182c-1774-49bb-80af-019de8b642c7",
"company_type_name": "sample string 32",
"company_type": {
"id": "62731113-df95-490d-8927-9579622ba600",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f42734a2-3aba-430a-9f42-4d04a00a72ac",
"sales_organization_code": "sample string 5"
},
"db_language_id": "72733ad3-3cda-47b7-82f8-8835f995126c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ba38bd6e-cd19-4548-9c8a-5d8a46e89e48",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d025423f-4907-4587-9840-61c65b2bf8eb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "134d19fb-6c44-4cf3-9eb9-c88648974676",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-18T02:58:47.3925723+00:00"
},
"company_sector_id": "717ca797-bc44-4500-b634-0f546c44fb25",
"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": "f7f60eb4-5fba-4f4d-80da-7a0d5e89be87",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0ce06d52-992b-498f-84ba-882453ea5aab",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6412f3f2-4db5-460a-8367-a063d1a0e4a9",
"account_manager_user_code": "sample string 56",
"company_status_id": "902f2358-6e3c-463e-8bc6-6042ec5fe71d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-18T02:58:47.3925723+00:00",
"id2": 60
},
"db_language_id": "c8a38d7e-cc96-4283-9be9-1556f93dcd6c",
"db_language_code": "sample string 7",
"db_title_id": "0776ef8d-72bf-4d4a-8944-20d2d03593ec",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-18T02:58:47.3925723+00:00",
"create_date": "2026-08-18T02:58:47.3925723+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-18T02:58:47.3925723+00:00"
},
"modified_dateutc": "2026-08-18T02:58:47.3925723+00:00",
"id2": 22
}