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": "60c3fcfe-71e3-46d2-853d-adc0569fe864",
"_parent_id": "91ebbd56-2cf4-450d-8d54-0be3a30fa5ef",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2bf7ccf3-6481-488d-80fa-79ecd4a0e397",
"company_id": "5ebbfcb0-3604-4a04-b609-fa1b30c172ba",
"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": "8df543b4-30aa-4733-9192-aa3babf28c88",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ddd81cb5-f05f-407d-bd26-0ecad5dfc896",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "27120242-58eb-4a99-b62f-e1146eac1e8c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "40cf1055-7738-483a-855e-d56bad884b2d",
"company_code": "sample string 5",
"company": {
"id": "dc6bd6dc-3b57-44e4-9071-749a076cd173",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-04-25T18:02:10.2215564+00:00",
"sales_territory_id": "23e9d2e4-6b1e-4278-8096-f6c05d71d799",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "365c9174-fa31-45e7-b763-99bad4499e43",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0f164828-a0a8-4f5c-82bc-31df92f19729",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f3a4d043-43af-4349-ae98-ce3e3024620e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81ccd0c8-7dc9-46e6-84fc-a754b19d3c46",
"db_currency_id": "b518318f-57ff-4db8-b446-040e843ff8ad",
"db_language_id": "29ead134-7e6a-4daf-8284-189751cf1a29",
"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-04-25T18:02:10.2215564+00:00"
},
"modified_dateutc": "2024-04-25T18:02:10.2215564+00:00"
},
"marketing_segment_id": "54ac11ad-f622-43a3-b915-201e671013a1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bc87d135-cce9-4d97-9f12-11e469591af1",
"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": "8b384773-a5f9-4166-ba4e-af93fa49b548",
"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": "e069d5f4-8005-4bfd-88d3-ff3b0f049d3d",
"db_country_code": "sample string 28",
"feelist_id": "485f71e1-8cdf-4656-bc89-756c28d200de",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "de3c8d95-f9d7-4a26-ace3-12dc74d993cb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "17eba4f3-b655-4445-ae3c-186cff001100",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-04-25T18:02:10.2215564+00:00",
"db_currency_id": "56a8ee86-55ed-4d43-a78c-1a32f5eeafb2",
"db_currency_code": "sample string 10"
},
"company_type_id": "77bc35d6-90cd-4a29-bc71-d5d730fd12da",
"company_type_name": "sample string 32",
"company_type": {
"id": "02ead244-834f-4737-82b9-147b39496560",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "070ac3e0-923e-413d-bda7-e484eaace429",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c21e0548-a8d5-4f0c-9617-aa89a910daef",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a9b6f94c-cdff-428b-8274-c80fd53ddbe8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "25b1fda9-a0b1-46e1-b6ce-c3966434273d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "014f28f5-4495-4de3-840a-451b57419e59",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-04-25T18:02:10.2215564+00:00"
},
"company_sector_id": "3595f0c8-1573-4279-8363-5edb23c3cceb",
"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": "6f8b4b12-bdd6-4c14-9768-d9bda54e45b1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d583efbe-fb27-4f33-94a6-57a0c3cc517f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f195766f-06b2-4627-afe0-450ed3404e3f",
"account_manager_user_code": "sample string 56",
"company_status_id": "b0189326-9d11-4548-9899-efbb85c02a91",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-04-25T18:02:10.2215564+00:00",
"id2": 60
},
"db_language_id": "f4407b9b-ed53-42cc-9807-576ff4f0f7b5",
"db_language_code": "sample string 7",
"db_title_id": "4147b3c4-be7d-4d94-b69f-25c5fbfe1ee1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-04-25T18:02:10.2215564+00:00",
"create_date": "2024-04-25T18:02:10.2215564+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-04-25T18:02:10.2215564+00:00"
},
"modified_dateutc": "2024-04-25T18:02:10.2215564+00:00",
"id2": 22
}