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": "a9247363-b460-4bdb-913d-6f4b913501cc",
"_parent_id": "8485c337-e262-42e3-9e72-bb27ec4c3bcb",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "03cd1976-345c-4db3-908a-ec5afbb37f04",
"company_id": "d9413972-664d-407a-8312-e6d2c26ed1aa",
"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": "3abb8323-3818-4446-9a14-11a99e205b9a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "cc3cf82d-855a-4998-9681-89e523679d27",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "5b6fab3b-bf31-41c0-af3f-1bfd123ffc71",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "efa7adaa-672b-493e-bff7-51c73d1139e9",
"company_code": "sample string 5",
"company": {
"id": "8fabbf2b-c968-4042-8d59-b3ddf6093f12",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-07-20T07:18:49.4891828+00:00",
"sales_territory_id": "4333ed54-9525-407e-b7e3-e2d8a8988e9c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "52becaf8-82e3-4055-b241-38c55083ead2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3aad477a-cb87-4294-8d6d-edce912af344",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "449927f5-9628-431b-8bdf-f83ebf2d0825",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "02c727d0-0c5a-47dc-a80f-2fa9ffdffcb1",
"db_currency_id": "e826cabc-5e4b-4814-afde-b7b2e2b82937",
"db_language_id": "1e0eb6c5-edfe-42f7-8bba-1155394f1399",
"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-07-20T07:18:49.4891828+00:00"
},
"modified_dateutc": "2024-07-20T07:18:49.4891828+00:00"
},
"marketing_segment_id": "2eb1266f-b81f-4861-ba78-97dd73fd6f18",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "564aafc0-d2c6-4e95-b904-779b305b0a5a",
"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": "ed44a07f-de30-41e4-9c66-32b25844dcf1",
"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": "6c45b277-6127-49b7-8dd8-446475445071",
"db_country_code": "sample string 28",
"feelist_id": "2b0b48c3-6a14-4ed3-8d87-14d34da43541",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8055e30a-5c1f-4413-b097-7720321012d0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "33de3b64-505b-409c-886e-07807469da33",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-07-20T07:18:49.4891828+00:00",
"db_currency_id": "d6829fc1-448d-417e-81cd-b2ae6578b6fd",
"db_currency_code": "sample string 10"
},
"company_type_id": "fe303acd-e5ee-4993-90ac-799a536c2d56",
"company_type_name": "sample string 32",
"company_type": {
"id": "02f0af14-753e-4a71-a755-5bfbbe632386",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bec8635d-f000-440d-aef5-54e98fa127b3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9475e268-4a4f-4bc7-aaac-d8d0a6611607",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f5db6690-161b-4416-8b7a-c08126872182",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b3b384c2-5af6-449e-8c88-c2bab2b37b47",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "700ee940-74a4-48e4-a636-283d80dda6e1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-07-20T07:18:49.4891828+00:00"
},
"company_sector_id": "7a950944-74fd-45b1-ba6b-8f94ce2e332e",
"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": "963fd36c-5513-4dc7-8381-2016c7da26fc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "abf37b4d-5628-4e5c-8405-cc15f5104fa0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4bb3e062-78f3-4021-b9ef-49a422b31de5",
"account_manager_user_code": "sample string 56",
"company_status_id": "06d03890-c62b-4601-acb8-4c775d9d7f0b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-07-20T07:18:49.4891828+00:00",
"id2": 60
},
"db_language_id": "d34f85be-55f6-4e46-a5ee-96908ed7a413",
"db_language_code": "sample string 7",
"db_title_id": "a481e5ae-2fe9-48ea-822e-f927458f4afb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-07-20T07:18:49.4891828+00:00",
"create_date": "2024-07-20T07:18:49.4891828+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-07-20T07:18:49.4891828+00:00"
},
"modified_dateutc": "2024-07-20T07:18:49.4891828+00:00",
"id2": 22
}