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": "4bdf4a8e-d705-459e-a1de-a553c3c3dad8",
"_parent_id": "3bce2de0-1db0-4f9c-a720-6ba4652bc4f9",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "bf17465f-53f6-4940-9c4b-b2ca8d62e99c",
"company_id": "a3e51408-274a-4e45-b1fb-746f5a8eb560",
"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": "3bda6855-3638-44e0-9dd8-ec8fa18ab437",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ef418211-1906-49a1-9626-9b62fcad35a5",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "66692946-93e1-4ff8-abd2-d414dfe27709",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4cdecbc7-93a5-4236-9424-464564890a03",
"company_code": "sample string 5",
"company": {
"id": "2fcc5b5f-504d-4107-ac1c-fe0e2dc153f2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2022-12-06T06:11:19.6609135+01:00",
"sales_territory_id": "13d25c9f-495d-48f4-9749-3008703be255",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3f81001c-f927-4c6a-8011-a6e8ea5202e5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d6a3ce56-8fdc-412f-aef0-11d01dde7590",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1541d7f9-f59a-45b5-a9b1-707722ce8e79",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c067b499-ca99-49e0-a285-34c9fc6ee741",
"db_currency_id": "4afa7e0b-6470-4781-8b67-459475e0e247",
"db_language_id": "bca7bc1c-5c95-4e95-a28a-b159673db0c1",
"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": "2022-12-06T06:11:19.6609135+01:00"
},
"modified_dateutc": "2022-12-06T06:11:19.6609135+01:00"
},
"marketing_segment_id": "230dd598-713b-42c5-b2bc-2ccb181a324c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d930d1e5-a8f9-489a-b31a-35bc39e6dbad",
"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": "ebe2597e-69fa-4fb0-ade1-fcd1e7ef27d2",
"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": "be76905e-779d-4a7c-97ce-6c715d4781ca",
"db_country_code": "sample string 28",
"feelist_id": "a32647ef-aa94-43d0-923d-e1db3ad6dcb6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6650b75a-2c73-4e8a-a274-436fa15e63ef",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "54862c43-4986-47dd-9ad7-32048ed19d0a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2022-12-06T06:11:19.6609135+01:00"
},
"company_type_id": "12171d3a-fd2b-4b65-ad61-593973e5b4ad",
"company_type_name": "sample string 32",
"company_type": {
"id": "a8c9a0d2-1097-4eee-9ef6-b332b71783a0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b748b4d2-334b-4e71-8050-c964b374d78c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d6baa455-4b94-4edc-97ab-f871b3d770da",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "deecdcdf-b6ce-40bd-93ab-4435ca21522a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "18cebf54-b5ef-4a97-a7a9-21f9a35e02a5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2359c226-a4b3-46b7-9958-f29b062a78e8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2022-12-06T06:11:19.6609135+01:00"
},
"company_sector_id": "86a236af-287f-46e2-a126-6f6dee13ba2f",
"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": "1e789412-325f-4ef4-975b-c76db8e93631",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c654fade-f11f-4104-b928-2662225a81c7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6063afcd-aaf3-44e9-9376-9576971260cc",
"account_manager_user_code": "sample string 56",
"company_status_id": "f9e584ed-187e-4262-84d9-3da9a4a49dde",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2022-12-06T06:11:19.6609135+01:00",
"id2": 60
},
"db_language_id": "09a1ee17-f90e-44cc-af5c-c39f9adb3b31",
"db_language_code": "sample string 7",
"db_title_id": "d92c18a2-bdcc-45e8-b93c-65ba417cffc7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2022-12-06T06:11:19.6609135+01:00",
"create_date": "2022-12-06T06:11:19.6609135+01: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": "2022-12-06T06:11:19.6609135+01:00"
},
"modified_dateutc": "2022-12-06T06:11:19.6609135+01:00",
"id2": 22
}