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
locationName | 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
{ "id": "4d70576d-a3c9-4302-ac63-c2088a3160da", "_parent_id": "d6557e58-7735-4343-b6e3-c672e6b9bd5b", "_parent_reference_back_office": "sample string 3", "project_status_id": "92ed2763-9eaf-4cf7-baee-983e85bd90ce", "company_id": "54a08454-c121-420f-ac91-37000e9f2211", "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": "0577287e-7455-49f3-abc1-9bf4312c2239", "db_country_code": "sample string 17", "street2": "sample string 18", "latitude_decimal": 1.0, "longitude_decimal": 1.0, "contact_id": "6ad39e18-b00c-499e-a88b-d37ad1ecc376", "contact_reference_back_office": "sample string 20", "contact": { "id": "12012dbe-1d2d-4dfc-b957-c78a6fad2cb9", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "cd1620eb-608f-4532-ad52-bc00fb7a590a", "company_code": "sample string 5", "company": { "id": "f1f60a61-16fd-4061-aa80-816d8e32c70d", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-10-14T00:05:38.6233437+00:00", "sales_territory_id": "f0885d06-b7d5-48b1-9176-1ed3fb21030f", "sales_territory_code": "sample string 9", "sales_territory": { "id": "c1648a8c-dd63-4fb7-874e-373780f9fc5c", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "12f76812-ef69-4c32-8ee3-438f6f4d00a2", "sales_organization_code": "sample string 5", "sales_organization": { "id": "b976ba16-0eae-45b2-98db-1123a5679822", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fcffeaf1-a56d-42db-8ab7-a519d4572494", "db_currency_id": "27589be3-faf9-49c9-b343-ee4d7a05eb10", "db_language_id": "ee19356e-ec29-442d-bf0e-8815b8186e78", "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-14T00:05:38.6233437+00:00" }, "modified_dateutc": "2025-10-14T00:05:38.6233437+00:00" }, "marketing_segment_id": "09b32524-90b2-48c0-a4df-1453a6fccedf", "marketing_segment_code": "sample string 11", "sales_organization_id": "a9ce4823-33e2-44bd-b797-808d2d9ba93b", "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": "98a0f43c-6277-456f-8ac2-6a632215897f", "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": "8dcc5619-7587-4ddc-a65b-5b76d69a0205", "db_country_code": "sample string 28", "feelist_id": "8b25a4b4-872e-4c26-821e-0a27e650d6bc", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "19ab1563-a094-4ab0-b820-11ca8ce1bc4d", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "1f805605-7c6d-4e69-b318-55a9a3d77fa1", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-10-14T00:05:38.6233437+00:00", "db_currency_id": "af1500d8-7344-4ad2-af43-e9fb45e790ce", "db_currency_code": "sample string 10" }, "company_type_id": "79f9537c-2553-4b95-8934-125041908204", "company_type_name": "sample string 32", "company_type": { "id": "7fb215e7-c2c5-48a1-84f5-d60dcc9873e4", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "f6d4d198-03b6-47ae-8215-41d3ef2b1f50", "sales_organization_code": "sample string 5" }, "db_language_id": "f53defcc-6a17-4c10-b08e-5af767777dda", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "4d9b7e1a-0be4-4d51-bcb7-a666100667f8", "article_price_label_code": "sample string 37", "db_payment_method_id": "5e6268ed-6083-4e41-b97c-473661b82881", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "09b3e7f5-ff08-4eb8-9235-ae67e87f119b", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-10-14T00:05:38.6233437+00:00" }, "company_sector_id": "caeb7aaf-a47d-4c67-b8b5-eecd7210a92e", "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": "a921b583-e13c-4e27-bd30-f79b09d0f7f4", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "8622dbcd-bcd4-4dbd-aaf1-07c0ea67a4e1", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "cbf66a05-2980-4ca4-b9e4-728c96ce77c6", "account_manager_user_code": "sample string 56", "company_status_id": "a86f7d06-6bb8-4c55-ac18-062cc96c3475", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-10-14T00:05:38.6233437+00:00", "id2": 60 }, "db_language_id": "96bca040-3411-46b9-b801-1861455cb743", "db_language_code": "sample string 7", "db_title_id": "94fe5e88-49cd-4f05-99ee-a0ff28be1386", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-10-14T00:05:38.6233437+00:00", "create_date": "2025-10-14T00:05:38.6233437+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-14T00:05:38.6233437+00:00" }, "modified_dateutc": "2025-10-14T00:05:38.6233437+00:00", "id2": 22 }