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": "76985ff4-fadb-4532-a398-729b29f8afb3",
"_parent_id": "c456a76b-af66-4f20-a311-ecf6efb22fb4",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "58b25180-23bd-4c09-beaa-0532266645f9",
"company_id": "fd9f67da-4022-477d-b087-44805ce08663",
"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": "94878d94-f181-4342-9bec-de1925517e0c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "18018095-10a7-405e-92cd-d8dad09ec204",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6632bbd0-6e95-4f2a-a9ad-b6bc24dc022c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c1ac2482-3df9-48f8-b741-f6ae0caced4f",
"company_code": "sample string 5",
"company": {
"id": "9be39db6-779c-41e6-b356-6827aba4e62b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-11-20T11:16:06.630432+00:00",
"sales_territory_id": "9c1b8c3c-22ff-4955-b5a2-635e3382289f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6c31420e-7d76-43cf-be4c-29ef416bfd75",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e0b958ca-91bd-4e8d-81c0-504e2724d479",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b6193f0f-4da0-427f-b286-9ef57d534cc6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8205f64a-40fc-418c-8f4e-c27f0d5d25c7",
"db_currency_id": "94b5cd74-04cb-491c-953d-c0086f777648",
"db_language_id": "a5da2c0e-ca66-4f5f-b54d-d620295ba96e",
"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-11-20T11:16:06.630432+00:00"
},
"modified_dateutc": "2024-11-20T11:16:06.630432+00:00"
},
"marketing_segment_id": "c4ff98c9-c31f-4dc0-ab05-c03e57c08fe2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "586b1e3d-177f-4c0c-9390-6cba3951a9d7",
"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": "f68573ab-3a8f-4f43-bb1d-f2aaba381a45",
"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": "3399d28f-9f92-405f-89d3-bf9dc5ad56e2",
"db_country_code": "sample string 28",
"feelist_id": "14750aeb-61cf-49ab-85df-0040364365b6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c329f6f9-15b8-420c-baf1-64fc2a3027af",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d722da37-8246-4bab-88e3-9e0428a0d682",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-11-20T11:16:06.630432+00:00",
"db_currency_id": "1fa58475-460a-4b38-9ff1-3208ed295aa1",
"db_currency_code": "sample string 10"
},
"company_type_id": "bbe86a64-5e83-487b-8856-dc2dd2c92a33",
"company_type_name": "sample string 32",
"company_type": {
"id": "03f8ea3e-4577-4f4a-b55c-18434b517d4e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5a2f1622-edfa-4b02-8e01-b9c6970e278c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bf961b10-f8a2-4be6-a173-eee636b422d4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7d09048e-e6f8-4d1a-825a-c3d9467f76ff",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "035ab8d9-ded1-48d2-ae14-dd56b003176e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6d407b2a-a9db-4333-b3a9-c2019d2f6313",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-11-20T11:16:06.630432+00:00"
},
"company_sector_id": "a69c230b-3703-4eaa-b42e-0515e368395d",
"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": "8553b1b8-c6cc-41de-8e33-bb2c67652811",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e1027a59-78cb-4e73-ac0f-35c8332e7688",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "233153aa-6764-45b5-894b-5f2b367cf64c",
"account_manager_user_code": "sample string 56",
"company_status_id": "3d43a8d9-c818-4330-97c1-954465f7f8d6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-11-20T11:16:06.630432+00:00",
"id2": 60
},
"db_language_id": "a75c5024-f22f-47e3-bd87-54743c74b177",
"db_language_code": "sample string 7",
"db_title_id": "bc4ff2c4-88d3-4480-86e2-58a054d8b993",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-11-20T11:16:06.630432+00:00",
"create_date": "2024-11-20T11:16:06.630432+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-11-20T11:16:06.630432+00:00"
},
"modified_dateutc": "2024-11-20T11:16:06.630432+00:00",
"id2": 22
}