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": "59f294e6-8835-4ce3-9e61-5195fdd27325",
"_parent_id": "b39db7d5-df2e-44de-b8b5-171b8cd63041",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6e42ed88-37c7-426c-9215-7e14f984e986",
"company_id": "773d9871-aebb-4840-8118-cf1d179d39e4",
"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": "e1d2c990-1a93-4249-a6fd-957250d1d7a6",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "433d4e94-34e7-4c4f-8b4f-f86f03721745",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "8ffdba26-a95e-439a-94d8-50f7259d12bd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b2163952-8b1c-4a1d-b605-4dbc3798bea2",
"company_code": "sample string 5",
"company": {
"id": "f2b69c62-37bc-40b2-92a6-715503c0b5f7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-07T10:20:03.1984674+00:00",
"sales_territory_id": "ec6deb20-32fe-4cfe-863f-bd906e205f54",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fd723e69-86e2-496f-ae61-efa13a73fb64",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a6ad42c5-507c-4e16-bc90-6d92dc0bd70e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f28cdd71-4e78-48c0-b911-2466c138fca8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f265d591-6560-454a-bbf9-72f8634a79e5",
"db_currency_id": "baf59e52-7434-4a50-a171-27a0e447343f",
"db_language_id": "5937172f-fbdd-4fbc-beba-5753656fa919",
"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-01-07T10:20:03.1984674+00:00"
},
"modified_dateutc": "2026-01-07T10:20:03.1984674+00:00"
},
"marketing_segment_id": "ec7bfc40-aca3-46c4-b2f9-84d84c229ca3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "addad96c-dc9e-4a85-be28-c6826e819f36",
"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": "81e42c06-7c64-4686-94fc-1b3e5501df55",
"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": "10395f71-f51d-44f0-a519-81ae93ab2868",
"db_country_code": "sample string 28",
"feelist_id": "30f241d3-bbae-435a-be10-c0c1e41906b8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "badd0af7-500d-487f-b84a-6abe225a567d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2c53044f-3011-4d57-b29e-632d1004f244",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-07T10:20:03.1984674+00:00",
"db_currency_id": "940eb3e0-7070-4eed-9f82-c63558a90401",
"db_currency_code": "sample string 10"
},
"company_type_id": "2ecb1c72-166e-4f0e-9960-2c7bf28764b0",
"company_type_name": "sample string 32",
"company_type": {
"id": "a9f69575-3c6b-4f63-a3a5-86022cbb874d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cd3e9812-a900-499b-bac3-806a5cba6b91",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2489af27-55c1-4239-bee0-19a8d4f02589",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8e597ef0-6fb9-417c-b670-1dc888db0ca0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "190e63bb-7e56-4897-9168-b3ae7fce7402",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4ea964e2-6bb8-49ab-8031-c8652e016903",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-07T10:20:03.1984674+00:00"
},
"company_sector_id": "aee711e7-7c3c-42db-bd1f-4a61146044fd",
"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": "1542a337-7b97-4f70-abce-90c8b66a0831",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "17f4c139-36e5-4614-a2ad-f8c14caf732b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8c05b194-0314-4072-b62a-bcd6e8e4d7ad",
"account_manager_user_code": "sample string 56",
"company_status_id": "210d3b30-aab1-4712-bf0c-f9a1c61e1c48",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-07T10:20:03.1984674+00:00",
"id2": 60
},
"db_language_id": "e9c3f445-1ac2-4f61-a8b4-09f33742d79e",
"db_language_code": "sample string 7",
"db_title_id": "6f5b0a8d-525d-46c5-91e8-c61639ac327a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-07T10:20:03.1984674+00:00",
"create_date": "2026-01-07T10:20:03.1984674+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-01-07T10:20:03.1984674+00:00"
},
"modified_dateutc": "2026-01-07T10:20:03.1984674+00:00",
"id2": 22
}