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": "f70c344a-0a15-4ef4-904f-992330442650",
"_parent_id": "2cf24b9e-98ba-479d-9ba1-11c0941bafeb",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "0212089e-bf00-4e18-8984-00246f75b531",
"company_id": "44a88510-5a56-4ee7-a990-c934baa679b0",
"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": "62bdccd3-c814-4b53-85ad-04f0a656bf77",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ee09ba7e-c351-4df3-9841-f96dd212e178",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0886b452-d344-4041-9aa8-7b402679e316",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e9f43343-264b-49fb-aae7-0b46d9f88c23",
"company_code": "sample string 5",
"company": {
"id": "a04db09c-4b12-4149-ae54-68f7ac6d8b10",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-07T17:10:08.8862084+00:00",
"sales_territory_id": "d3f78d0e-9d6d-44b0-9148-66325365adf8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "066f675e-aebf-4869-a19f-ea7dfe4a0775",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1b5bfa63-9f0d-4f3f-8b22-ccf767fd3e26",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b02d9f84-c8fa-4db0-90fc-c38fb5c01293",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d1a9292-363e-4559-baee-f4cc71b5830a",
"db_currency_id": "526511f5-c16f-4063-a4b8-eb0de1a19b51",
"db_language_id": "d5b38de4-eece-4c2b-97e8-61d0b386e09c",
"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-05-07T17:10:08.901834+00:00"
},
"modified_dateutc": "2025-05-07T17:10:08.901834+00:00"
},
"marketing_segment_id": "c60052d9-60a8-44c3-ab3e-122148a7a3ac",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ddf374de-9efc-4a3b-8312-8e6ffa478baf",
"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": "41eec691-5c8e-439c-8678-008fde8c194c",
"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": "4e9273d3-49b5-4019-9ce8-bc56d093a4ae",
"db_country_code": "sample string 28",
"feelist_id": "8b4a88a3-afc4-43cf-ae2d-a62ee9fc474d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c744a94e-37aa-4fb5-8a61-a7f0c4c329c2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "008ac842-2584-4e6d-ad11-520ad6047a39",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-07T17:10:08.901834+00:00",
"db_currency_id": "ef0f511a-cd41-4810-8b91-5b18848e6c3b",
"db_currency_code": "sample string 10"
},
"company_type_id": "52327a12-a921-4855-a1be-4020bfa2fa32",
"company_type_name": "sample string 32",
"company_type": {
"id": "6aaac007-22df-4bb3-a0c9-372d6681c761",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "924be7c9-41bd-4c3d-afb8-58de6eae536d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4096cf46-c430-4056-8894-cc31a9b3ebe1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3fd60993-1d66-4ceb-baea-a292f987c860",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "717dfe05-268f-4061-a528-7437c629dd91",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d13710df-779b-4efb-9971-1730d5183c7b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-07T17:10:08.901834+00:00"
},
"company_sector_id": "6f9e7ffc-6d5f-4190-a6fb-e1295438c5ed",
"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": "678ebe70-7e34-4c05-85e1-d1ab19738214",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c477bd64-9c64-4e45-a2df-75200f8c90d3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6b17ce77-0cb7-408a-a425-84f07963ff38",
"account_manager_user_code": "sample string 56",
"company_status_id": "00aeee27-4eb6-4286-aea8-ad8c4e5e00a2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-07T17:10:08.901834+00:00",
"id2": 60
},
"db_language_id": "a1f95fb4-cbcf-4f9d-a48b-9c4941ef8d1d",
"db_language_code": "sample string 7",
"db_title_id": "51c2dc0c-9e10-400a-9285-0b5ae6768190",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-07T17:10:08.901834+00:00",
"create_date": "2025-05-07T17:10:08.901834+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-05-07T17:10:08.901834+00:00"
},
"modified_dateutc": "2025-05-07T17:10:08.901834+00:00",
"id2": 22
}