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 | |
udf1 |
Custom field udf1 |
string | |
udf2 |
Custom field udf2 |
string | |
udf3 |
Custom field udf3 |
string | |
udf4 |
Custom field udf4 |
string | |
udf5 |
Custom field udf5 |
string | |
udf6 |
Custom field udf6 |
string | |
udf7 |
Custom field udf7 |
string | |
udf8 |
Custom field udf8 |
string | |
udf9 |
Custom field udf9 |
string | |
udf10 |
Custom field udf10 |
string | |
udf11 |
Custom field udf11 |
string | |
udf12 |
Custom field udf12 |
string | |
udf13 |
Custom field udf13 |
string | |
udf14 |
Custom field udf14 |
string | |
udf15 |
Custom field udf15 |
string | |
udf16 |
Custom field udf16 |
string | |
udf17 |
Custom field udf17 |
string | |
udf18 |
Custom field udf18 |
string | |
udf19 |
Custom field udf19 |
string | |
udf20 |
Custom field udf20 |
string | |
udf21 |
Custom field udf21 |
string | |
udf22 |
Custom field udf22 |
string | |
udf23 |
Custom field udf23 |
string | |
udf24 |
Custom field udf24 |
string | |
udf25 |
Custom field udf25 |
string | |
udf26 |
Custom field udf26 |
string | |
udf27 |
Custom field udf27 |
string | |
udf28 |
Custom field udf28 |
string | |
udf29 |
Custom field udf29 |
string | |
udf30 |
Custom field udf30 |
string | |
udf31 |
Custom field udf31 |
string | |
udf32 |
Custom field udf32 |
string | |
udf33 |
Custom field udf33 |
string | |
udf34 |
Custom field udf34 |
string | |
udf35 |
Custom field udf35 |
string | |
udf36 |
Custom field udf36 |
string | |
udf37 |
Custom field udf37 |
string | |
udf38 |
Custom field udf38 |
string | |
udf39 |
Custom field udf39 |
string | |
udf40 |
Custom field udf40 |
string | |
udf41 |
Custom field udf41 |
string | |
udf42 |
Custom field udf42 |
string | |
udf43 |
Custom field udf43 |
string | |
udf44 |
Custom field udf44 |
string | |
udf45 |
Custom field udf45 |
string | |
udf46 |
Custom field udf46 |
string | |
udf47 |
Custom field udf47 |
string | |
udf48 |
Custom field udf48 |
string | |
udf49 |
Custom field udf49 |
string | |
udf50 |
Custom field udf50 |
string | |
udf51 |
Custom field udf51 |
string | |
udf52 |
Custom field udf52 |
string | |
udf53 |
Custom field udf53 |
string | |
udf54 |
Custom field udf54 |
string | |
udf55 |
Custom field udf55 |
string | |
udf56 |
Custom field udf56 |
string | |
udf57 |
Custom field udf57 |
string | |
udf58 |
Custom field udf58 |
string | |
udf59 |
Custom field udf59 |
string | |
udf60 |
Custom field udf60 |
string | |
udf61 |
Custom field udf61 |
string | |
udf62 |
Custom field udf62 |
string | |
udf63 |
Custom field udf63 |
string | |
udf64 |
Custom field udf64 |
string | |
udf65 |
Custom field udf65 |
string | |
udf66 |
Custom field udf66 |
string | |
udf67 |
Custom field udf67 |
string | |
udf68 |
Custom field udf68 |
string | |
udf69 |
Custom field udf69 |
string | |
udf70 |
Custom field udf70 |
string | |
udf71 |
Custom field udf71 |
string | |
udf72 |
Custom field udf72 |
string | |
udf73 |
Custom field udf73 |
string | |
udf74 |
Custom field udf74 |
string | |
udf75 |
Custom field udf75 |
string | |
udf76 |
Custom field udf76 |
string | |
udf77 |
Custom field udf77 |
string | |
udf78 |
Custom field udf78 |
string | |
udf79 |
Custom field udf79 |
string | |
udf80 |
Custom field udf80 |
string | |
udf81 |
Custom field udf81 |
string | |
udf82 |
Custom field udf82 |
string | |
udf83 |
Custom field udf83 |
string | |
udf84 |
Custom field udf84 |
string | |
udf85 |
Custom field udf85 |
string | |
udf86 |
Custom field udf86 |
string | |
udf87 |
Custom field udf87 |
string | |
udf88 |
Custom field udf88 |
string | |
udf89 |
Custom field udf89 |
string | |
udf90 |
Custom field udf90 |
string | |
udf91 |
Custom field udf91 |
string | |
udf92 |
Custom field udf92 |
string | |
udf93 |
Custom field udf93 |
string | |
udf94 |
Custom field udf94 |
string | |
udf95 |
Custom field udf95 |
string | |
udf96 |
Custom field udf96 |
string | |
udf97 |
Custom field udf97 |
string | |
udf98 |
Custom field udf98 |
string | |
udf99 |
Custom field udf99 |
string | |
udf100 |
Custom field udf100 |
string |
Response Formats
application/json, text/json
{ "id": "5df24202-c635-4cd2-9895-d88c9a9f7b80", "_parent_id": "11ac8200-da56-44b8-bd1b-c392efa19a49", "_parent_reference_back_office": "sample string 3", "project_status_id": "0bcddd5c-cacb-4934-93f0-52a295d959ec", "company_id": "b4854008-fc89-46a6-b1c7-729a23f62513", "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": "28c646bf-e449-4686-b2d9-a18024ce72ee", "db_country_code": "sample string 17", "street2": "sample string 18", "latitude_decimal": 1.0, "longitude_decimal": 1.0, "contact_id": "89a29ed5-ea89-4dc1-b706-c8948718e158", "contact_reference_back_office": "sample string 20", "contact": { "id": "81ad26d8-7ec8-428c-a254-3f17c75a9f3d", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "e8d982f3-6980-43b2-8dbf-f78670e12c98", "company_code": "sample string 5", "company": { "id": "fb056e7d-0e66-454e-9280-b8d33f36ab86", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-10-13T22:01:50.4282387+00:00", "sales_territory_id": "6f205d0c-0440-4183-a07f-c516d9310358", "sales_territory_code": "sample string 9", "sales_territory": { "id": "0866b434-3cd6-465b-b6c9-60f32f10b70c", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "aa2b22e0-5dd0-4635-9b8d-b14ea535cbac", "sales_organization_code": "sample string 5", "sales_organization": { "id": "1f7eef10-476d-4363-9a9c-bd2b6e21da45", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "0b0c4cb2-c48b-4420-9407-8f80551e6b56", "db_currency_id": "3c625fb4-aa93-4572-b251-b4ea9c4ad2b1", "db_language_id": "0831a2a6-9038-4705-8828-2d97b763600e", "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-13T22:01:50.4282387+00:00" }, "modified_dateutc": "2025-10-13T22:01:50.4282387+00:00" }, "marketing_segment_id": "d22d9131-dafd-44af-9ae0-88359de6c7d7", "marketing_segment_code": "sample string 11", "sales_organization_id": "b73e4141-0c14-4522-a47a-556b33a18149", "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": "6d9fe4ef-a52c-4eda-b4d5-d0885795060a", "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": "95c6debb-e7d2-4a3e-9e98-5fc434bab616", "db_country_code": "sample string 28", "feelist_id": "fb17be05-20ec-4919-9e5e-6a60510d5f88", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "661953e8-72f3-40e4-8a3c-aff341f588ec", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "791fbed2-4138-492b-8543-e52c8fe34dca", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-10-13T22:01:50.4405502+00:00", "db_currency_id": "87786eca-ef14-4d47-af11-0c133e28ba1e", "db_currency_code": "sample string 10" }, "company_type_id": "70d25d32-3257-44b6-918b-dd31b1add1b0", "company_type_name": "sample string 32", "company_type": { "id": "dd13c6e4-3c57-4720-ba34-aace4fe2cb6e", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "1b53dc92-0543-4a52-a0b6-cc3e420004a6", "sales_organization_code": "sample string 5" }, "db_language_id": "98923d8d-5054-4ae4-97e5-5247a5bd8370", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "59ce2736-b4a2-4d50-bc90-b3a1025aa3ed", "article_price_label_code": "sample string 37", "db_payment_method_id": "77c8258e-a8e8-466a-92e0-36457a4fc6fd", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "d7631b42-6a00-4c4a-8f8c-a965b8ad56e3", "name": "sample string 2", "pm": "sample string 3", "description": "sample string 4", "reference_back_office": "sample string 5", "activated": true, "modified_dateutc": "2025-10-13T22:01:50.4405502+00:00" }, "company_sector_id": "917364f6-42b0-4285-becd-cd0dd54634d6", "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": "824718c7-12ce-4eb3-9dd7-be9a31cc1747", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "781ed6a3-c200-4a9a-90c7-5af2bd944456", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "4f6e4b27-0df5-4faf-8025-a373bc8bf5c3", "account_manager_user_code": "sample string 56", "company_status_id": "0ecd608c-52ce-407c-9365-33c27581ccc1", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-10-13T22:01:50.4405502+00:00", "id2": 60, "po_number_required": true, "invoice_contact_id": "1435a0ee-f388-44b7-bd7b-901862471b1f", "due_monthend": true, "payement_conditions": "sample string 64", "udf1": "sample string 65", "udf2": "sample string 66", "udf3": "sample string 67", "udf4": "sample string 68", "udf5": "sample string 69", "udf6": "sample string 70", "udf7": "sample string 71", "udf8": "sample string 72", "udf9": "sample string 73", "udf10": "sample string 74", "udf11": "sample string 75", "udf12": "sample string 76", "udf13": "sample string 77", "udf14": "sample string 78", "udf15": "sample string 79", "udf16": "sample string 80", "udf17": "sample string 81", "udf18": "sample string 82", "udf19": "sample string 83", "udf20": "sample string 84", "udf21": "sample string 85", "udf22": "sample string 86", "udf23": "sample string 87", "udf24": "sample string 88", "udf25": "sample string 89", "udf26": "sample string 90", "udf27": "sample string 91", "udf28": "sample string 92", "udf29": "sample string 93", "udf30": "sample string 94", "udf31": "sample string 95", "udf32": "sample string 96", "udf33": "sample string 97", "udf34": "sample string 98", "udf35": "sample string 99", "udf36": "sample string 100", "udf37": "sample string 101", "udf38": "sample string 102", "udf39": "sample string 103", "udf40": "sample string 104", "udf41": "sample string 105", "udf42": "sample string 106", "udf43": "sample string 107", "udf44": "sample string 108", "udf45": "sample string 109", "udf46": "sample string 110", "udf47": "sample string 111", "udf48": "sample string 112", "udf49": "sample string 113", "udf50": "sample string 114", "udf51": "sample string 115", "udf52": "sample string 116", "udf53": "sample string 117", "udf54": "sample string 118", "udf55": "sample string 119", "udf56": "sample string 120", "udf57": "sample string 121", "udf58": "sample string 122", "udf59": "sample string 123", "udf60": "sample string 124", "udf61": "sample string 125", "udf62": "sample string 126", "udf63": "sample string 127", "udf64": "sample string 128", "udf65": "sample string 129", "udf66": "sample string 130", "udf67": "sample string 131", "udf68": "sample string 132", "udf69": "sample string 133", "udf70": "sample string 134", "udf71": "sample string 135", "udf72": "sample string 136", "udf73": "sample string 137", "udf74": "sample string 138", "udf75": "sample string 139", "udf76": "sample string 140", "udf77": "sample string 141", "udf78": "sample string 142", "udf79": "sample string 143", "udf80": "sample string 144", "udf81": "sample string 145", "udf82": "sample string 146", "udf83": "sample string 147", "udf84": "sample string 148", "udf85": "sample string 149", "udf86": "sample string 150", "udf87": "sample string 151", "udf88": "sample string 152", "udf89": "sample string 153", "udf90": "sample string 154", "udf91": "sample string 155", "udf92": "sample string 156", "udf93": "sample string 157", "udf94": "sample string 158", "udf95": "sample string 159", "udf96": "sample string 160", "udf97": "sample string 161", "udf98": "sample string 162", "udf99": "sample string 163", "udf100": "sample string 164" }, "db_language_id": "b27e744e-5357-479b-85df-f1d07bb2ab28", "db_language_code": "sample string 7", "db_title_id": "001f711c-3b56-4e65-9b95-f52d7ca39145", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-10-13T22:01:50.4405502+00:00", "create_date": "2025-10-13T22:01:50.4405502+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-13T22:01:50.4405502+00:00" }, "modified_dateutc": "2025-10-13T22:01:50.4405502+00:00", "id2": 22, "udf1": "sample string 23", "udf2": "sample string 24", "udf3": "sample string 25", "udf4": "sample string 26", "udf5": "sample string 27", "udf6": "sample string 28", "udf7": "sample string 29", "udf8": "sample string 30", "udf9": "sample string 31", "udf10": "sample string 32", "udf11": "sample string 33", "udf12": "sample string 34", "udf13": "sample string 35", "udf14": "sample string 36", "udf15": "sample string 37", "udf16": "sample string 38", "udf17": "sample string 39", "udf18": "sample string 40", "udf19": "sample string 41", "udf20": "sample string 42", "udf21": "sample string 43", "udf22": "sample string 44", "udf23": "sample string 45", "udf24": "sample string 46", "udf25": "sample string 47", "udf26": "sample string 48", "udf27": "sample string 49", "udf28": "sample string 50", "udf29": "sample string 51", "udf30": "sample string 52", "udf31": "sample string 53", "udf32": "sample string 54", "udf33": "sample string 55", "udf34": "sample string 56", "udf35": "sample string 57", "udf36": "sample string 58", "udf37": "sample string 59", "udf38": "sample string 60", "udf39": "sample string 61", "udf40": "sample string 62", "udf41": "sample string 63", "udf42": "sample string 64", "udf43": "sample string 65", "udf44": "sample string 66", "udf45": "sample string 67", "udf46": "sample string 68", "udf47": "sample string 69", "udf48": "sample string 70", "udf49": "sample string 71", "udf50": "sample string 72", "udf51": "sample string 73", "udf52": "sample string 74", "udf53": "sample string 75", "udf54": "sample string 76", "udf55": "sample string 77", "udf56": "sample string 78", "udf57": "sample string 79", "udf58": "sample string 80", "udf59": "sample string 81", "udf60": "sample string 82", "udf61": "sample string 83", "udf62": "sample string 84", "udf63": "sample string 85", "udf64": "sample string 86", "udf65": "sample string 87", "udf66": "sample string 88", "udf67": "sample string 89", "udf68": "sample string 90", "udf69": "sample string 91", "udf70": "sample string 92", "udf71": "sample string 93", "udf72": "sample string 94", "udf73": "sample string 95", "udf74": "sample string 96", "udf75": "sample string 97", "udf76": "sample string 98", "udf77": "sample string 99", "udf78": "sample string 100", "udf79": "sample string 101", "udf80": "sample string 102", "udf81": "sample string 103", "udf82": "sample string 104", "udf83": "sample string 105", "udf84": "sample string 106", "udf85": "sample string 107", "udf86": "sample string 108", "udf87": "sample string 109", "udf88": "sample string 110", "udf89": "sample string 111", "udf90": "sample string 112", "udf91": "sample string 113", "udf92": "sample string 114", "udf93": "sample string 115", "udf94": "sample string 116", "udf95": "sample string 117", "udf96": "sample string 118", "udf97": "sample string 119", "udf98": "sample string 120", "udf99": "sample string 121", "udf100": "sample string 122" }