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": "95ce3a24-8d43-4302-ba87-041a2d4e47cd",
"_parent_id": "42fce236-8c58-49dd-8857-031f36c61c4d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "d757638f-77cc-4958-946c-607da9164d50",
"company_id": "95740442-5ab8-483f-a326-8cd5c0992879",
"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": "6a8dcb0d-6205-4e3a-a4a8-144c8293d6cf",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "1cd48fa5-c6b7-4178-9e25-f2c75bb1cdfc",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "b8fd113b-1a82-4eee-8c9f-d0afbe755796",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "82d997fd-d2e5-4ffd-a06e-e3d8e256b775",
"company_code": "sample string 5",
"company": {
"id": "cb4338e1-9ef5-44df-92cd-59432c4e7303",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-25T14:33:13.0692809+00:00",
"sales_territory_id": "0ab86e5a-055c-47ea-9e4d-e265135a9524",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b9d2d185-62b9-401e-b5ef-407cbd45357d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5835094e-e12f-4688-bbf9-26fd5f38c895",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3349765f-b5e4-4430-95a1-632204ddc540",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b02ee019-79e8-49b2-996c-19abaf55506b",
"db_currency_id": "f587730a-88a1-4e14-a53c-d403bd44b454",
"db_language_id": "ceb6c6f3-12f8-48ab-972b-01a7adc5a573",
"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-09-25T14:33:13.0849029+00:00"
},
"modified_dateutc": "2026-09-25T14:33:13.0849029+00:00"
},
"marketing_segment_id": "b135b615-c96f-414c-8f38-5a55951f12e8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d52128fe-e454-43d3-8ec3-5da0e3410803",
"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": "d3391114-1253-4c93-bd39-95b59965f76c",
"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": "ff092011-979c-4ffc-8e98-79c50c1af9d9",
"db_country_code": "sample string 28",
"feelist_id": "88e7ca85-f60d-49ed-be9b-b0e33e1bdc1e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "efe7e978-a7e5-4c87-b7e5-3b305a09e5ec",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "42d8f08d-a636-4091-bc8b-1371fcebbbc3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-25T14:33:13.0849029+00:00",
"db_currency_id": "4c4f96a6-2814-47e3-a3bf-6c996d5457af",
"db_currency_code": "sample string 10"
},
"company_type_id": "d544b6f8-ef13-4752-aa16-3d64580c7de6",
"company_type_name": "sample string 32",
"company_type": {
"id": "c96fbc01-bb9f-4311-a355-205163eb75a3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "655780dd-3184-4326-bce2-1b7bf45e802f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "19c5e475-7387-4a13-a164-500035ec6a21",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "12bc9b3a-e36e-486f-aa5c-68c61a62864e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f6a0a3e7-dd61-499a-887c-770bb1cd47e4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "81bfb60a-cf1e-4f29-95aa-59cf3ca8c256",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-25T14:33:13.0849029+00:00"
},
"company_sector_id": "d2ced026-3dc0-4ce1-8619-f9496464fa5d",
"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": "e2a2691e-66eb-4c00-b2fa-cb7ffcbe529b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fb431f1e-59a3-4956-b3ff-02444ea85c8f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f941fae6-8bcd-4998-9cc4-1ea093b12a73",
"account_manager_user_code": "sample string 56",
"company_status_id": "9ddcc6c1-71ed-4953-81d4-f25ff803d7c2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-25T14:33:13.0849029+00:00",
"id2": 60
},
"db_language_id": "12f4870a-e4da-4068-9a04-0883ebd2597b",
"db_language_code": "sample string 7",
"db_title_id": "9253d120-1fca-4a5c-b8e3-c6a1dc3c1345",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-25T14:33:13.0849029+00:00",
"create_date": "2026-09-25T14:33:13.0849029+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-09-25T14:33:13.0849029+00:00"
},
"modified_dateutc": "2026-09-25T14:33:13.0849029+00:00",
"id2": 22
}