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": "3d90f56c-e9c2-42a2-ae49-2e665557d811",
"_parent_id": "1fee47cd-69fd-4d15-8ef1-e92844b43eb2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "99f58a1e-3954-4a46-8f11-2c185eb281c1",
"company_id": "dc954564-284a-4bc0-94b2-98d71491ad4e",
"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": "0a7945dc-b9b0-45b4-aff4-02bd68b53133",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f6d91c37-15e1-457f-8cd2-958140fda31a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "d69a640f-b1fc-4e41-b497-beec483dd0be",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "81ce0ac7-1e27-4e27-a596-b4b83286241a",
"company_code": "sample string 5",
"company": {
"id": "b0d49e7c-c667-4e13-bbd8-e4002c5ac7fb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-12-21T13:36:31.3250702+00:00",
"sales_territory_id": "f67bf8d4-4fa7-4e22-b843-66204bc5edeb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ff29214d-69af-4897-8add-78018f5aaeb8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c8a3bbd0-bbb9-4c92-9858-6714d0731282",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e74fd2ae-fc27-4425-8657-f4bd3375ddfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93e5823c-f53d-49af-bebd-312bbf0c27e7",
"db_currency_id": "d5f6f66a-fed2-4ab4-8351-c8912b4be415",
"db_language_id": "84de78d2-f8f1-4659-8309-036da99a7f00",
"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-21T13:36:31.3250702+00:00"
},
"modified_dateutc": "2024-12-21T13:36:31.3250702+00:00"
},
"marketing_segment_id": "0cf48135-d063-460d-a4e4-6207825ebab2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "81d75122-c731-4be9-a4d4-80bd0da22a18",
"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": "bdcfd51e-7e0e-4d58-bfd4-19051a2520df",
"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": "a3f49f00-9f4f-4c52-9a76-c5115a3a868e",
"db_country_code": "sample string 28",
"feelist_id": "b50e8643-f67a-4bc5-b9a2-abe9b70151af",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "886b2042-0f71-4dac-be1d-4aece37f26ee",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8a08e818-8eb0-4b42-967b-806fdf04a8da",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-12-21T13:36:31.3407491+00:00",
"db_currency_id": "27685ba0-47d1-482a-9987-b8d8bde70cfd",
"db_currency_code": "sample string 10"
},
"company_type_id": "afdb4737-3efa-4afb-813c-73d50ff501a4",
"company_type_name": "sample string 32",
"company_type": {
"id": "043faf5b-fb4d-4a20-bfa6-31dcf5f274a5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "48fec8ff-cb15-4689-9e09-7d3209b5d371",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5a3f53ee-3f88-480f-b3fb-65165bd60c8a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "56eb47b9-eb37-4800-b38a-b4b18912fd35",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6b981c18-6f36-45c1-827f-9dbd6efe650c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "24a1ccd7-9903-4010-9b94-98522d61697d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-12-21T13:36:31.3407491+00:00"
},
"company_sector_id": "87bd3c09-0644-4114-9cdb-e47286799168",
"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": "68e524af-0058-4860-b9e4-da3cb82d5d25",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "120cfe8c-3d16-4524-b34e-f70e40c0d0fc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1aaa583a-2f75-4d6a-9399-6cb5ec144901",
"account_manager_user_code": "sample string 56",
"company_status_id": "366316fc-405a-4b08-8fec-6000a0ccf0e0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-12-21T13:36:31.3407491+00:00",
"id2": 60
},
"db_language_id": "cae94d81-811a-4f82-8ad9-75456b93f13b",
"db_language_code": "sample string 7",
"db_title_id": "57a540a5-9ae7-42da-bac5-a643de63db6f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-12-21T13:36:31.3407491+00:00",
"create_date": "2024-12-21T13:36:31.3407491+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-21T13:36:31.3407491+00:00"
},
"modified_dateutc": "2024-12-21T13:36:31.3407491+00:00",
"id2": 22
}