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": "117b6fda-8029-4642-83d5-3cc48b681c59",
"_parent_id": "5f129592-9ab4-4034-8985-a5b58004ac0e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a780003a-7a35-4e6d-ab86-3aa137378c4e",
"company_id": "08b6d449-80e7-442c-84cc-c53a033e4be8",
"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": "7e3a2654-7012-4e47-b89d-d6e32045d34b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "8dd438ef-fdcc-4547-8d9a-e290a6310668",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "b67c398c-a8d1-452e-8490-72439bb37aca",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a42df68c-e788-41ce-aeaa-d975224c5f3c",
"company_code": "sample string 5",
"company": {
"id": "a21e297e-27e3-477c-9013-c5f4d8bb4452",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-11T09:48:13.267487+00:00",
"sales_territory_id": "615e8d7d-84a0-46db-a23e-026af8d9bf83",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "540bfd25-bbf4-4d7f-8092-be94e669f580",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a1c08388-5737-4cca-90ae-0e6e3d19a3cc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4295f7c6-adfe-41f7-98a1-28c002537426",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e511dbf-c96e-4c11-8e5c-1a9e96fae565",
"db_currency_id": "5469d63e-60d8-4ab3-a461-cf6ee522f435",
"db_language_id": "a52a4ac8-9200-4063-95f2-4e1be362a3e8",
"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": "2025-10-11T09:48:13.267487+00:00"
},
"modified_dateutc": "2025-10-11T09:48:13.267487+00:00"
},
"marketing_segment_id": "ebee884e-afbc-4717-bc53-8d8e401453cb",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d92bdc3c-3987-4d69-94f6-26291e6f3989",
"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": "75c3827e-4291-43bb-8b2c-4fcc75907bb3",
"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": "6f05b7e4-351c-4e93-98b6-1429a265cc7b",
"db_country_code": "sample string 28",
"feelist_id": "42e7292f-fa2c-4f48-bcdd-d650cb2b5671",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "658f2f63-4edd-46f0-b7ca-3bc4d6bc3acc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3c1ef5ea-f91c-4600-9c9a-d04800c0472b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-11T09:48:13.267487+00:00",
"db_currency_id": "7dc2f411-073f-4da6-901a-9e43adcfbeed",
"db_currency_code": "sample string 10"
},
"company_type_id": "7af7b13c-0066-4cd1-bc10-8f71aedaca64",
"company_type_name": "sample string 32",
"company_type": {
"id": "fe23cd81-83ed-4c55-baf9-4b00ce68cfff",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8e61ffa4-2b69-48fa-aa41-e0b09f058627",
"sales_organization_code": "sample string 5"
},
"db_language_id": "67c93f06-6363-4aec-80bf-7f8b81945417",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5804a7e4-6c76-46b9-9e42-2c82839e5fe1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cfa2c46e-1e2c-40b2-9cbc-791300097ccc",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bea35cac-7ff1-4819-a869-f82b82764d48",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-11T09:48:13.267487+00:00"
},
"company_sector_id": "d1965d8e-d564-4c87-98e3-feb438410626",
"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": "8ba76b64-b52c-4472-bafa-347802ee8b7e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0a999a37-c401-472c-97e7-d5dd73facc32",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f4dbc12c-4199-4778-a317-a0d0d67c51c0",
"account_manager_user_code": "sample string 56",
"company_status_id": "4e0cee5c-27a5-4667-8083-629ac8d57c77",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-11T09:48:13.267487+00:00",
"id2": 60
},
"db_language_id": "9507c7eb-dd22-4997-b6fc-24d8a091cfbc",
"db_language_code": "sample string 7",
"db_title_id": "0d41a24a-e392-42e7-b7c6-a1cc0fc2744a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-11T09:48:13.267487+00:00",
"create_date": "2025-10-11T09:48:13.267487+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": "2025-10-11T09:48:13.267487+00:00"
},
"modified_dateutc": "2025-10-11T09:48:13.267487+00:00",
"id2": 22
}