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": "16751634-0cf3-49e7-90a6-0256f047a83b",
"_parent_id": "df27367b-47e3-441e-add0-a3a51f466435",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1abb6b80-a8b2-42fb-b978-3aa4af28c7ac",
"company_id": "c8455139-9368-4fc6-8a8b-687beaa1a971",
"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": "b803b69a-f247-49be-91ad-88a18550d920",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d3e76394-5d30-4acc-9143-8c7bfe83edf8",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "56b8cfe6-0c19-4ba0-8efc-5ed2e941bd09",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7dd5f159-72fc-4d56-b366-8007273d7aea",
"company_code": "sample string 5",
"company": {
"id": "3c20da4a-c570-4f05-a822-0c744b3e3b4d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-05T19:19:23.3414734+00:00",
"sales_territory_id": "9ea4b92e-b12b-4b28-a264-80119e25e586",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bc8b2002-b6f0-42d4-af6a-deb800e0e808",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d4b58c73-b105-496c-9d71-37cc334ed0fd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5ff14132-1a38-49c3-ba87-1b22acf0f1e3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b369d8-d0fb-4f18-974d-53c2356ae3f8",
"db_currency_id": "6db8b984-3478-43e0-8930-8da29afa3510",
"db_language_id": "178f052e-8891-406e-8494-70b2d9056175",
"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-07-05T19:19:23.3414734+00:00"
},
"modified_dateutc": "2025-07-05T19:19:23.3414734+00:00"
},
"marketing_segment_id": "00cd66a5-d305-4c54-b833-b20596d1cf3f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "98e81135-3db4-4497-a53a-879977bdcba2",
"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": "a947afce-1e02-4ca4-9632-edbcb1504236",
"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": "2e8933ae-be58-49fc-b5cc-04a141a2f663",
"db_country_code": "sample string 28",
"feelist_id": "36c18910-4fc9-48b0-827d-d28bf0ecc0c2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9358fa0c-8e42-4f38-9a43-b62a183ffade",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fde96eb5-9480-4971-ac7f-683aa0ed7363",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-05T19:19:23.3414734+00:00",
"db_currency_id": "a86ab42b-d94b-49de-b9e0-481f33c26321",
"db_currency_code": "sample string 10"
},
"company_type_id": "5b0686a9-54d5-498f-93fe-406713e3c51c",
"company_type_name": "sample string 32",
"company_type": {
"id": "fddf00df-f2eb-4f76-a0c2-5c904c12a730",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "127d9b5c-5820-453c-b267-b70444d2f819",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fb2b578f-43cc-4b47-80ba-688fa9a17f1d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cc10849b-8337-46da-877f-550731193fff",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "02d7fbd5-bff7-4007-9b71-73e7c88f5282",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "768b1980-6087-445a-a5a3-49ce89b4ea83",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-05T19:19:23.3414734+00:00"
},
"company_sector_id": "81677708-0856-4dc0-8337-c5325bffb61a",
"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": "9149b509-8b3d-4486-af9f-482739e73621",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "efe10bf2-f19e-4fb6-84cf-94238fccd588",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ea05205d-c004-40bf-be32-da8c390d0c5c",
"account_manager_user_code": "sample string 56",
"company_status_id": "099498e2-7a5c-4109-ba56-82e9823e9d28",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-05T19:19:23.3414734+00:00",
"id2": 60
},
"db_language_id": "5db28c4d-7ee7-4fdd-bf4b-8d1f3acb9349",
"db_language_code": "sample string 7",
"db_title_id": "27438190-b795-4ef0-b5f4-a5c7f0671671",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-05T19:19:23.3414734+00:00",
"create_date": "2025-07-05T19:19:23.3414734+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-07-05T19:19:23.3414734+00:00"
},
"modified_dateutc": "2025-07-05T19:19:23.3414734+00:00",
"id2": 22
}