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": "e0ae01f9-beec-4f32-9650-2924691f7a73",
"_parent_id": "b9a6bfd5-9f98-4caf-bbc3-78a2a28ad9fa",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "27daff7b-03cc-4f80-a549-d979f549c811",
"company_id": "b9917118-a695-42d7-9f4b-cd452213ac4f",
"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": "c6bc3410-6bd8-4b27-9c64-a4d3e6828aa3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "838fef40-17b4-4f34-aa82-f02c855df8ad",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ceac024f-c182-499b-af23-673e30068269",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d4b269f3-2daa-411a-ba5a-b9fe20a96d86",
"company_code": "sample string 5",
"company": {
"id": "9b900fd3-9f8f-4bf3-b063-37cd910bc8e5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-12-26T16:36:25.1836232+00:00",
"sales_territory_id": "34b39cd7-a9aa-4d1c-b5d1-8194c289e3f2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7e5b7d6c-1ed0-4e0b-bac0-39defa5d15ec",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e5059c33-2436-4bac-8157-8369a10605f7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "70aedf95-2a88-4195-859d-b216c456e3f4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "07684e31-3600-4d0c-89a2-bbc1132d485c",
"db_currency_id": "061aba08-26d3-4a79-9d0e-6895455ea117",
"db_language_id": "e67cd218-d13f-4dc1-a3c2-2e7fb77af314",
"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": "2024-12-26T16:36:25.1836232+00:00"
},
"modified_dateutc": "2024-12-26T16:36:25.1836232+00:00"
},
"marketing_segment_id": "3677e95d-dd1a-47dd-b079-782fd36546bc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "269d983f-4225-4ce6-a5e3-40cc51effff6",
"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": "5afb8420-a67e-4e2c-a9b6-18adde2b24c5",
"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": "ef883f51-3273-408a-9ebc-77e005bba5e6",
"db_country_code": "sample string 28",
"feelist_id": "8d33a27a-f918-4cdb-9192-157939488e63",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1715dd8d-dc3a-4051-80d8-2bb49384cbb5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "74be67e3-0414-4805-bf83-154035c15708",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-12-26T16:36:25.1836232+00:00",
"db_currency_id": "f6fec0cf-0482-4a22-b91a-59cd1bc2df36",
"db_currency_code": "sample string 10"
},
"company_type_id": "345909ba-0587-4f06-9c1c-ce1e4a45ec84",
"company_type_name": "sample string 32",
"company_type": {
"id": "8cfdc361-f79f-47cd-8f91-981e9010f5bb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "238dfc1e-35b9-41b5-a1db-b2a7dc00970b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9ce2ec74-0723-440c-835c-dd1d92475690",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9aad0286-0fd4-47ef-b340-a799dbd18bde",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0c266973-8d3b-416d-a035-cbfda3b9909f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "03df2768-61b5-440a-984e-1c3c49d44ddc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-12-26T16:36:25.1836232+00:00"
},
"company_sector_id": "dff75776-cedc-493a-9300-fdb2fbc3977c",
"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": "f4733deb-9249-429e-a783-afb18ce44562",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e8f02c78-67ce-4974-bf63-fe881409a85c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "af494d65-c01b-4068-9186-ffb4e97e4fcc",
"account_manager_user_code": "sample string 56",
"company_status_id": "bdcf0b83-648d-4cbc-bf44-81bd92063734",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-12-26T16:36:25.1836232+00:00",
"id2": 60
},
"db_language_id": "f131bf6d-97dd-41e5-bbec-39b35b4461f4",
"db_language_code": "sample string 7",
"db_title_id": "442469b2-9898-470e-b37d-8ba85326c468",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-12-26T16:36:25.1836232+00:00",
"create_date": "2024-12-26T16:36:25.1836232+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": "2024-12-26T16:36:25.1836232+00:00"
},
"modified_dateutc": "2024-12-26T16:36:25.1836232+00:00",
"id2": 22
}