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": "634e0918-18fc-4b4e-ad83-088a9e7e5018",
"_parent_id": "3f8e8272-399c-41d0-af71-e96dedfd5a4e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1ecf7250-de82-452d-be0a-33b3b3372e60",
"company_id": "4216f2da-b9ce-4c5f-9047-44501884cd05",
"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": "aa27ffd9-04fb-42b4-8d30-6f5cbfcd8607",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "1ee58942-fbc6-4e90-a293-79f427f3812d",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "145a472f-6150-4ede-8004-5cdd8154b4a9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a9ff60e3-325b-4597-b292-b98f6919c674",
"company_code": "sample string 5",
"company": {
"id": "9245e05e-6269-4c1a-bab3-31fbae3e0e3e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-01T21:26:36.6075575+00:00",
"sales_territory_id": "adee8e5d-326a-440a-9b88-2cfbbe7ad970",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e212692f-cc43-4a71-bef6-5d60fbd45bfb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b529859b-ba92-4639-9a3f-0157688cfe08",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2bf82cd6-8878-4524-8f79-d785628951e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "967fb3d9-cc11-4be0-9d4c-8f308a6f91a6",
"db_currency_id": "221ce53f-482e-4f3a-a7c8-95576b3419ba",
"db_language_id": "abce9a00-801a-4374-b4df-5d2ce1f08692",
"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-06-01T21:26:36.6075575+00:00"
},
"modified_dateutc": "2026-06-01T21:26:36.6075575+00:00"
},
"marketing_segment_id": "b0f5e55e-28c6-4e4c-8423-f83f1041badf",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1305d8fb-0e3f-4976-ad43-763a91886a5a",
"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": "c1542e3c-e4f9-4d0d-8bc8-90e936ffb876",
"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": "bf5f7d79-080e-4855-bb48-4d61a68f3c78",
"db_country_code": "sample string 28",
"feelist_id": "a4c20562-876f-4edb-b0e2-f3f000c056f8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c9c2f328-79e4-4956-afee-a78c0f44cce3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "949db55c-2bd4-489a-ad19-953ebb334749",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-01T21:26:36.6075575+00:00",
"db_currency_id": "e0eb4fe4-6fa8-44eb-8705-f0bd874cef40",
"db_currency_code": "sample string 10"
},
"company_type_id": "1e51b371-214a-4456-8f6d-0e078f9e4a78",
"company_type_name": "sample string 32",
"company_type": {
"id": "8040a127-d698-4fcc-970e-f5266f9a8fd7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7702ef4a-eef9-459f-9a26-ede2a75a4ff9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1e78ce74-b5b2-45a1-8a95-b9f0e5cacada",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "765cb40a-e365-4ee8-a960-33db410f27c7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d95ba4f4-3d32-4884-9e12-396e99df57ce",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f0a95956-4d1d-4a7d-9cc0-392a2e0650ba",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-01T21:26:36.6075575+00:00"
},
"company_sector_id": "66701ba9-d4cd-4640-a01e-c6285df2c81b",
"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": "df2ae34b-5d3c-4dd4-b4b5-4f79885bc077",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "39262a19-b2a9-468c-915e-6b2aeb093936",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "312c89d6-8e78-4b7d-9e2f-658db4476bd5",
"account_manager_user_code": "sample string 56",
"company_status_id": "cde0073b-9849-429f-ada1-95ba10bf512a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-01T21:26:36.6075575+00:00",
"id2": 60
},
"db_language_id": "662f9ad7-cf4e-443a-b31e-6ccb45432a6f",
"db_language_code": "sample string 7",
"db_title_id": "37092521-2e89-46c3-a86c-582f37456dd5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-01T21:26:36.6075575+00:00",
"create_date": "2026-06-01T21:26:36.6075575+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-06-01T21:26:36.6075575+00:00"
},
"modified_dateutc": "2026-06-01T21:26:36.6075575+00:00",
"id2": 22
}