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": "97d543d8-bd3d-45bd-bda6-e552bccb0559",
"_parent_id": "8c7132d6-0330-4868-88c2-f6b1a46efafb",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f4e3c6dc-d8dd-4ecb-a3f1-1cb5ef2b6dd1",
"company_id": "3b4b2879-676e-42f7-9f3b-05b9b1aeef69",
"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": "faa61e14-c00e-44b8-a36c-167ca075e9f2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "024c8a3e-9584-4082-a5a9-4790c90e727b",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "aa5cfb5e-3aab-4d01-924a-9efa6adef8b2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a29326d4-2c1b-4ea4-b89d-16b789f8b56f",
"company_code": "sample string 5",
"company": {
"id": "d8f2c229-78ce-4f12-9d87-ecd2de711ec3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-30T17:55:04.329439+00:00",
"sales_territory_id": "02c1c0f1-4b5d-408d-801d-6ecdcdb92382",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c2071d66-b7c3-4af1-b1f1-669e6af02022",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ea5fadc8-e4e6-4e78-8a9c-9d4bf9b4b410",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "de0e9e99-5617-4dd3-ad77-0fafb46428fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba1115c9-983e-47c5-93e1-3e16d9119aaa",
"db_currency_id": "3cea00fe-5d1d-4e15-9724-139e92b4f183",
"db_language_id": "0162f0c9-8148-4451-ab5c-b11cc81e922d",
"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": "2026-08-30T17:55:04.329439+00:00"
},
"modified_dateutc": "2026-08-30T17:55:04.329439+00:00"
},
"marketing_segment_id": "4bd0c18c-5fd0-4239-93f9-5668f1164aa0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fcebfbec-fbe2-4979-83f4-84b0b88e4c9b",
"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": "5f658b32-293a-4303-abe2-7755729bc48b",
"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": "bf699228-f7ff-4eee-baa0-1a8d60025824",
"db_country_code": "sample string 28",
"feelist_id": "8099c402-faa4-4588-8c4b-5bf84d47aca5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "98533611-3d8a-42eb-b44d-055c201c3cdc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dc8d7ab4-2ed0-4534-9c8d-8e2fb3c2258b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-30T17:55:04.329439+00:00",
"db_currency_id": "9e124a65-75b3-4b0b-b92d-808e8ad3b705",
"db_currency_code": "sample string 10"
},
"company_type_id": "1474c0f0-fd41-4479-a82e-d6d1919ca7f3",
"company_type_name": "sample string 32",
"company_type": {
"id": "c312e0f7-3635-491b-a09f-3228f30d139c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b22b7091-7084-47cb-9214-32754bd5264a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "88ebe780-5d1b-4e32-9b2c-f6c4c9fe717a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "841204b7-1b7b-4f83-80ec-acc7b39c1e06",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "10ba6378-3ee8-4f55-aa84-fbeac3b63568",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7b1b48ab-dae6-48d7-89e2-14607f7ef014",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-30T17:55:04.329439+00:00"
},
"company_sector_id": "d59f12a3-2e26-400b-9620-e3cd3a6ae210",
"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": "3f1f8700-d2c6-46c3-aa76-f46768fb0695",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "35e8d16a-ce01-46d7-b2db-94962f2ee7b2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cb8df76a-3cbb-4d0c-85bf-e528fb5bcb52",
"account_manager_user_code": "sample string 56",
"company_status_id": "c84ec6d1-6a62-46f0-b2bd-1e2b223e4e32",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-30T17:55:04.329439+00:00",
"id2": 60
},
"db_language_id": "e7b4b962-a7e6-455f-b63b-71e52d637951",
"db_language_code": "sample string 7",
"db_title_id": "ade1c2f8-c9e3-42bf-a27d-2fcaaeeaff33",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-30T17:55:04.329439+00:00",
"create_date": "2026-08-30T17:55:04.329439+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": "2026-08-30T17:55:04.329439+00:00"
},
"modified_dateutc": "2026-08-30T17:55:04.329439+00:00",
"id2": 22
}