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": "3a413dde-d052-456d-94ee-fcd127895c1d",
"_parent_id": "e1f21b2f-d3d0-4f29-8602-1ad3ba47f55b",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2677cc7a-908c-4963-9278-b51b9895220c",
"company_id": "35648964-a183-4c61-a4f7-8e4ccbcee2c6",
"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": "d21aa1a6-f832-4a76-bc46-44be6fa8b957",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "5d02b4bb-3bf8-4552-967a-63b75717e381",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "807f69cd-630d-4a00-b302-d6960320e773",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4a09d9e6-9e53-4b97-a9ee-945fb0935300",
"company_code": "sample string 5",
"company": {
"id": "20dee4d3-649a-4c49-80f4-f78a0f1b2ce1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-05T07:02:17.4291036+00:00",
"sales_territory_id": "8f8a9a56-8f34-4831-a707-fd2dc7bf318d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "dbfbc55d-2a49-4e5c-8905-aed30401ed39",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fa074c04-296e-40a8-9cb5-d849f4a752fd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "825a8c9f-1b57-4c14-9e0d-2d7630af063c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb3eeb3d-114a-4330-9c37-547194e4248c",
"db_currency_id": "21b1b6d9-9bc9-4773-8f94-6b42f8ba79d2",
"db_language_id": "46012574-b9db-49a9-81a7-94b9502c3d6c",
"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": "2025-02-05T07:02:17.4291036+00:00"
},
"modified_dateutc": "2025-02-05T07:02:17.4291036+00:00"
},
"marketing_segment_id": "332a51c1-2298-4348-bcdd-abe3f230b57f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "38725b4a-731e-4907-9817-1fb05daa255f",
"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": "892c5531-2e6f-4ab1-8e06-67f618440dd5",
"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": "3093016e-bbc6-4231-b2cd-de639793db89",
"db_country_code": "sample string 28",
"feelist_id": "6f411512-81dd-4d85-8d06-7d332828ae62",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "59c80a15-db29-4a54-8126-6f645f551b21",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a37f7d17-5e4c-4100-85bf-6b20a992c907",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-05T07:02:17.4291036+00:00",
"db_currency_id": "01ea5494-7e23-43bf-8767-9eaaf8f1e624",
"db_currency_code": "sample string 10"
},
"company_type_id": "bf2c49b0-b5bd-4f84-be1d-390a46ee4c60",
"company_type_name": "sample string 32",
"company_type": {
"id": "ebf9697a-07ed-4aca-a5b2-f35564414880",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "51accb70-f5a9-4b9b-bb9a-b274ea2479df",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0df770ef-039f-4c56-9266-34602babe822",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "57250f31-c25b-4d4f-884d-93ae2b46866b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9d8a895c-59d6-4842-a9d0-9c59f298092b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "336d8f89-f95a-4d91-a517-0b5c204c6831",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-05T07:02:17.4291036+00:00"
},
"company_sector_id": "3107f8a3-0e71-49ae-8a72-0e3f79bff179",
"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": "8d71a37d-0f3d-406c-b2a0-cc5e4b89df1e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3d6acc78-e50a-4ab0-ae99-7155ef53af0a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8de848f1-eb68-4f2c-b928-942a1fd4ef79",
"account_manager_user_code": "sample string 56",
"company_status_id": "23848a14-fd3b-4b44-8210-3d7d75586b08",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-05T07:02:17.4291036+00:00",
"id2": 60
},
"db_language_id": "f5533c31-699d-45bb-9f8a-c595afd7a7fc",
"db_language_code": "sample string 7",
"db_title_id": "6ac08f47-7059-46c6-a618-430fdf8e4950",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-02-05T07:02:17.4291036+00:00",
"create_date": "2025-02-05T07:02:17.4291036+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": "2025-02-05T07:02:17.4291036+00:00"
},
"modified_dateutc": "2025-02-05T07:02:17.4291036+00:00",
"id2": 22
}