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": "bf641e72-6ee5-4088-8fde-76dba37d0a19",
"_parent_id": "af00d725-f48c-4517-a18a-400628deabac",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "8b941420-b7cd-4018-8bff-35b5db14d40f",
"company_id": "575affa7-613a-400d-b9e1-dad2133b0451",
"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": "66139ac4-e6da-401e-ac86-a9a98357e686",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b009feeb-547a-43ee-950c-4e1af4872d43",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3cb51e59-e7a3-44de-bff6-7f8afb1b8c97",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2b97f872-00c6-4342-8f79-0c0b5b028687",
"company_code": "sample string 5",
"company": {
"id": "ead7f3f9-caad-410e-8dde-90ed9bc36d48",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-26T02:58:46.2866046+00:00",
"sales_territory_id": "c3cd21b9-e57f-4378-bff7-a9b015bd24cb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c36ce9fc-922d-4274-97c9-7ddf2e80a675",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "253b0e2b-d886-4ca4-8c17-76231fc8c9d0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4ae1b60b-df6a-486b-81d9-8011f83b9c01",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d76bf69-f119-443a-a24b-657606260a9c",
"db_currency_id": "70482d61-02ef-4709-8009-5e5fbc0219fc",
"db_language_id": "a7bd8c0e-b6a4-4a5a-b147-7da419a454f2",
"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-06-26T02:58:46.2866046+00:00"
},
"modified_dateutc": "2026-06-26T02:58:46.2866046+00:00"
},
"marketing_segment_id": "67d492ce-150f-4b7b-8b5c-3399e6d4b83f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "796ad401-fb94-42c2-b189-d47b168665ed",
"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": "46192f9a-813b-4919-98e7-26dbcdff37ae",
"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": "35fe6ae6-93a3-4da0-82bc-b8a8e6953250",
"db_country_code": "sample string 28",
"feelist_id": "4b77d27b-5a54-489f-a0dc-09cb336f1fdf",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "89826df6-ab67-4b4f-8525-d4b9d104c4d2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1923239b-a4eb-46eb-8be3-f30022fe4e7d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-26T02:58:46.2866046+00:00",
"db_currency_id": "2264f481-a6c9-4cc5-b96c-9bd9dd3e49b7",
"db_currency_code": "sample string 10"
},
"company_type_id": "33eb1f8a-7dc4-4f04-b335-fccb2b898b41",
"company_type_name": "sample string 32",
"company_type": {
"id": "1f456fd5-8dda-48d5-a86e-28c4cf94568b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d8de4f7c-f7b1-4e39-8591-6b13f4c445f0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ec6c2fbb-c41d-40c5-aa3b-41c3453ef091",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8a97227a-4d5d-4859-9f5f-30931ecb6f1a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "489f229c-6895-4234-b2eb-f595c4e9f466",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c530820b-f8e2-49e3-8444-753c0a9947a0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-26T02:58:46.2866046+00:00"
},
"company_sector_id": "83fef374-f4ce-47d0-88ef-d97c372b8c63",
"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": "398c9cc4-012b-4bb5-aa62-03e5d06c0e33",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c0dd57ca-ae28-4a6f-ac18-6edeff9a9b09",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b7762506-74d8-4b58-b350-5c9578bb529a",
"account_manager_user_code": "sample string 56",
"company_status_id": "216e0ee1-15a6-4183-9944-4fa86d10d39c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-26T02:58:46.2866046+00:00",
"id2": 60
},
"db_language_id": "a3345df4-f1ec-492b-9e2f-defe01986691",
"db_language_code": "sample string 7",
"db_title_id": "e8d1d691-649d-4003-bd72-46d0a5958910",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-26T02:58:46.2866046+00:00",
"create_date": "2026-06-26T02:58:46.2866046+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-06-26T02:58:46.2866046+00:00"
},
"modified_dateutc": "2026-06-26T02:58:46.2866046+00:00",
"id2": 22
}