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": "3e53b577-22e8-42c2-9f2a-562f81e6fc8b",
"_parent_id": "c1af89db-3b1e-41a9-8ff2-e13c4601ad04",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "8611cecd-da4a-48cf-b402-1becc6f23cfa",
"company_id": "b01f441a-2c3f-4be7-a318-ae1cbf96fa5a",
"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": "786e4e79-8559-4620-a564-2fdec01c4323",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "2e3ca441-84a8-474c-a33d-19e3dbcbcb8c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "419139a0-c7e5-4235-9fb5-139f796496d2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b575c050-8d68-44c4-90cc-2cafc445b0ae",
"company_code": "sample string 5",
"company": {
"id": "e83143d8-6f2f-4e95-aa7e-3acfe85297f6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-24T03:25:15.9174244+00:00",
"sales_territory_id": "46864ea0-4f9a-4dd8-ad65-ce647b3f8f15",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d9831c6b-9bb1-4eef-a91c-01c924e9c523",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4d279628-bd53-4e16-b28c-606233e2b3d7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5050ec87-7962-4ff2-8ee3-093975f9f319",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf86e636-02e5-41ae-8e54-525efd6789e3",
"db_currency_id": "8cf65aa2-14f8-4b32-9db6-730166290392",
"db_language_id": "a25ecc0f-4679-426b-bafc-d4cf683aa7f4",
"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-03-24T03:25:15.9174244+00:00"
},
"modified_dateutc": "2026-03-24T03:25:15.9174244+00:00"
},
"marketing_segment_id": "b0c6985c-3294-4c3b-891f-b3aa87998e9d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f8df7149-6c36-4e3c-94d9-598d6055d23b",
"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": "43dbea86-071a-42e2-a2f8-d52dd3486c52",
"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": "1cb8189d-c9a5-425b-9e27-7b58af96e858",
"db_country_code": "sample string 28",
"feelist_id": "e88915ce-0c9a-4e34-a5b5-297c80d9e536",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3cfc1103-31c2-4c7d-b4f0-d3ffccfe774c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a441dc4d-7d06-455f-bc54-ab07bcaf3927",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-24T03:25:15.9174244+00:00",
"db_currency_id": "cf5427bb-26c5-4efc-903f-aae1419ca4be",
"db_currency_code": "sample string 10"
},
"company_type_id": "55e51831-6351-4d5a-8fb2-ace0f96618c6",
"company_type_name": "sample string 32",
"company_type": {
"id": "1ffb58d1-5f26-4e27-9224-83e86e345633",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "076f2eca-4e99-4667-89d7-d53dc039d806",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d30f245e-fb41-452a-befd-b9e4d3370590",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "12f98c58-db53-475c-879f-683a40473b7f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c2d39d18-856a-46b5-89cc-16ffb755cda9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "15da42cf-dcd3-4e62-885c-d591f95ce943",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-24T03:25:15.9174244+00:00"
},
"company_sector_id": "17455cd7-5717-4f35-b6bc-22099d49f1fa",
"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": "88815896-f66e-46da-a2dc-da486f352877",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "701cd12c-440a-4bcd-977f-6316f55a6cce",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d4da3092-85b8-409e-9cb3-46d2231e7227",
"account_manager_user_code": "sample string 56",
"company_status_id": "f5089bc0-30a2-4f4e-b759-4e4c64ae2b97",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-24T03:25:15.9174244+00:00",
"id2": 60
},
"db_language_id": "c6ecd097-eaac-4dfe-af75-4704df3c46d2",
"db_language_code": "sample string 7",
"db_title_id": "f25ad0f2-7de8-4643-a710-1f500a3309d2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-24T03:25:15.9174244+00:00",
"create_date": "2026-03-24T03:25:15.9174244+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-03-24T03:25:15.9174244+00:00"
},
"modified_dateutc": "2026-03-24T03:25:15.9174244+00:00",
"id2": 22
}