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": "02614917-0a01-45f4-9f50-3fb71d054040",
"_parent_id": "771ff8bf-8c4d-47a3-bd01-fe309b4ac99c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ef1290f0-82e1-4247-b250-631676e73e83",
"company_id": "546fbb4e-3d0b-47e5-95ca-eb7e97d19223",
"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": "646a08b1-9add-4507-916a-f1468971791b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b1fb3ad4-0040-41da-9eb5-90355281186b",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6034c989-3a81-4af1-ad8f-f3ad5812f1f0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "df1cfe6d-4a3c-43e8-a6f0-50aa719a80d0",
"company_code": "sample string 5",
"company": {
"id": "8701bd43-3b05-4566-962e-43d97670d1a9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-06T23:29:42.4017658+00:00",
"sales_territory_id": "9b4b492d-4226-4755-ba8e-4fe46e709000",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "055fd94b-deda-4249-9bd1-f3de1701151d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "90f93551-a375-476e-986f-86bb0ca8b58d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c438eda6-26a3-4cbe-9c37-0967d173db9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3eb4daf8-1bca-45e9-84e5-b915f4f8af0a",
"db_currency_id": "b6fcb6a6-41ea-4c76-832f-abe4d30d74c2",
"db_language_id": "b3b85557-0dc8-4646-a2cd-7eb159f859d9",
"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-07-06T23:29:42.4017658+00:00"
},
"modified_dateutc": "2026-07-06T23:29:42.4017658+00:00"
},
"marketing_segment_id": "26a726f1-e2b7-41a7-b2bb-f71925f77b8d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b90276b5-b5ec-4710-8ca6-c36b61187861",
"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": "718db154-6918-4a4e-a733-b407b77d2cae",
"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": "3e9c3372-a964-4d0e-b105-f75731ab463e",
"db_country_code": "sample string 28",
"feelist_id": "8827082a-32b6-4409-a55d-447340f21c13",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cc59a4a7-8d64-44c7-b5cc-70de3c126923",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "78ea3672-de0e-4eab-be0a-b080eb75d957",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-06T23:29:42.4017658+00:00",
"db_currency_id": "b7c391af-ab6e-4951-9d32-93570326829d",
"db_currency_code": "sample string 10"
},
"company_type_id": "9019dab4-abc0-4c5d-9f9c-e879e7c540d0",
"company_type_name": "sample string 32",
"company_type": {
"id": "dc7825d2-857d-46cd-937a-deebc875ff02",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7b41a6e1-9753-418d-bd31-74853ab47e3a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "212da6c7-493f-4c42-b823-6aae2523c59d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2d275de3-c4e5-4d28-a40f-a3020333e617",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "00ddc121-8614-4298-a6e9-243b3007732c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e2113fed-beb6-4796-9765-a806bdb5b0e5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-06T23:29:42.4017658+00:00"
},
"company_sector_id": "fab5aa8a-5126-4e86-80cd-a8729494fcff",
"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": "e6e371e0-38bc-4010-bc51-f16d9a114589",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fc924096-c9da-41af-9e8f-68947299fea8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3635c4a4-228f-4084-9955-cbe81966c31e",
"account_manager_user_code": "sample string 56",
"company_status_id": "6fe49b4f-cb5b-4f70-ad6d-0db549c8f145",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-06T23:29:42.4017658+00:00",
"id2": 60
},
"db_language_id": "0b6d275c-6034-474c-b2df-22ee22a21367",
"db_language_code": "sample string 7",
"db_title_id": "23b6ce69-f763-4d37-944c-71ada600c94b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-06T23:29:42.4017658+00:00",
"create_date": "2026-07-06T23:29:42.4017658+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-07-06T23:29:42.4017658+00:00"
},
"modified_dateutc": "2026-07-06T23:29:42.4017658+00:00",
"id2": 22
}