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": "570b4212-83d6-49b8-b06e-b13c2dfa0c85",
"_parent_id": "ce4c88ca-af57-46bd-bc0a-1533a355b5ab",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ea62cb94-49d0-48c5-9e96-ef119a6dd938",
"company_id": "caa2e4a0-b58e-475b-bb06-1986ff58dba1",
"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": "0e399a72-29b9-4dc1-8dc9-de4cbf0b82d5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "041d4e1a-452f-4589-85cd-28d725717723",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "d7c75f5f-e030-4fa9-a240-05608430ea0c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "66a0b395-a5ea-4cbc-a6da-482e854e9a14",
"company_code": "sample string 5",
"company": {
"id": "039c9534-78a7-4f2d-a979-4609327b90b8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-01-22T01:06:45.7263493+00:00",
"sales_territory_id": "8c01176e-0cf5-46fe-a318-48a085d2b5b5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "48e1aafb-30b1-43c4-bd87-3fc0a6421277",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "39565a12-a0f7-43d8-8311-4b63a7c266e3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e9f59d3f-443b-45b2-987f-c93f5e1818af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "485bffa2-1754-45a4-a8b2-9f8d4960882e",
"db_currency_id": "2535fda5-5095-484a-8323-81669bd58f39",
"db_language_id": "0fa3af24-5718-470f-a2ac-8e10eb981f6d",
"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-01-22T01:06:45.7263493+00:00"
},
"modified_dateutc": "2025-01-22T01:06:45.7263493+00:00"
},
"marketing_segment_id": "f6a9bbba-a03a-4677-976b-b3b0875dab16",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "88292238-00d8-4877-95ce-52572f39a6a0",
"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": "c1a2b5bc-75be-45d6-b9dd-4f3dfd7d0097",
"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": "781cae81-dcff-4590-a849-94d8ec3ffc49",
"db_country_code": "sample string 28",
"feelist_id": "383a3a40-9202-4516-b30c-0c699274fa97",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4961269f-38cc-4c38-9a5e-f38440acd32d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "43875e11-44a3-40c7-96ef-15903fff053a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-01-22T01:06:45.7263493+00:00",
"db_currency_id": "1c2a651f-a4e2-4550-9227-cb1bab0baf47",
"db_currency_code": "sample string 10"
},
"company_type_id": "69bc1dd3-6756-4b2c-848b-3ddbd952751f",
"company_type_name": "sample string 32",
"company_type": {
"id": "64564e38-b893-4b65-a8f0-1960f6ef9e9a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7428365f-1f49-4f32-8391-9336f1aca5db",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8259f3f5-ecf9-4b09-83ae-25f0d704cea6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "532d174e-363b-4d59-a713-136bd64ee9da",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "73bc5d44-485a-4edc-9db7-3129c001b9b5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "dac7d62b-d0a2-4097-9d87-64e723383e99",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-01-22T01:06:45.7263493+00:00"
},
"company_sector_id": "fdedfbd5-ea3b-4a2e-ab03-51c460c48f70",
"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": "013d5825-8a0c-4514-968f-444dd4019c58",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1e54b7e9-9b5c-4fba-b2b8-cefa415a33f8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "dc4dc67b-d6ad-414b-b82b-386cbe48e2d8",
"account_manager_user_code": "sample string 56",
"company_status_id": "5564b311-66ea-4a73-84d1-addac21fbf8a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-01-22T01:06:45.7263493+00:00",
"id2": 60
},
"db_language_id": "b4c73521-ac75-46e9-a837-62856b8e1fbb",
"db_language_code": "sample string 7",
"db_title_id": "78a18bb6-a1ec-4f8b-b077-9a0262ff29ad",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-01-22T01:06:45.7263493+00:00",
"create_date": "2025-01-22T01:06:45.7263493+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-01-22T01:06:45.7263493+00:00"
},
"modified_dateutc": "2025-01-22T01:06:45.7263493+00:00",
"id2": 22
}