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": "46696f4c-5114-4cab-acb6-5e5562343c1a",
"_parent_id": "3b1178e8-adb6-4dc7-bd40-d301ea6c8bd2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "035cb8c5-64ef-4431-b8dc-924e3e06bb72",
"company_id": "bc318240-93be-41cf-a6c9-1d0353cd1135",
"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": "72ca65ba-4152-4360-8883-6dbee0004cac",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c2713870-f04d-46b2-aef4-cb1aeaf44e4e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ce818f75-29dd-43bf-b1fc-930c73c89b04",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0bdb2b17-499a-44bb-aa4c-53ba76f39376",
"company_code": "sample string 5",
"company": {
"id": "394626af-e097-41a6-9b06-8192369a6756",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-30T07:19:32.7002387+00:00",
"sales_territory_id": "d0c15ceb-f82b-4a49-87b9-87e304e8a6af",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "67b56683-8b8b-412a-a99e-5137abbbec0f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "02a3ffc1-2c93-4fc5-8c41-10f259e4892a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cf57acee-23ce-41e5-a464-405b99af29ff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7790c12f-acb4-491a-9321-17771e55490b",
"db_currency_id": "39836b6e-df8c-4fad-9acd-324de3f2439f",
"db_language_id": "66bd43c2-f876-4995-9c53-2d022d8ed65a",
"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-05-30T07:19:32.7002387+00:00"
},
"modified_dateutc": "2026-05-30T07:19:32.7002387+00:00"
},
"marketing_segment_id": "e6d731f9-b5e7-4808-8391-5583b8ecea27",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "69010bfb-43c4-49a2-b361-597c7e8d9ead",
"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": "4422b14e-112a-40ff-8bfc-b79ff65efc64",
"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": "96e5de38-ae21-4fc8-bd0b-699af55d7d44",
"db_country_code": "sample string 28",
"feelist_id": "7ffe4eab-7dc0-4c24-8ab0-8762d6099bb1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6659a12e-b29f-4933-ba64-35c284e68376",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1b7545af-247c-4aeb-a72e-fe01ae22ade6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-30T07:19:32.7002387+00:00",
"db_currency_id": "5768b15e-a3ac-4418-96b5-86cb86430f5e",
"db_currency_code": "sample string 10"
},
"company_type_id": "8680e9b1-38fd-4a66-9860-5842fa216f14",
"company_type_name": "sample string 32",
"company_type": {
"id": "5c33df0b-c442-4a8e-95fb-9763eb5d3c9a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5e7bf860-315a-443b-8146-0eaae19052c8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fc682983-fd9e-4576-8358-569b9a9bb162",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8d671858-5764-4b46-bbeb-3214ae9626ea",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8bab54cd-ab0d-4bce-bbec-f39ace2e9e60",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f8a57ea8-50e1-4423-959d-d4b64aef3008",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-30T07:19:32.7002387+00:00"
},
"company_sector_id": "5286ebd9-5664-47c3-9cb4-60d491c2e456",
"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": "4d235a10-6a0d-417a-9b01-cfd306cbff22",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9a25999f-53b5-4b47-979a-4a4289811f29",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "12ce27e4-1d95-41d0-969a-2a19af9a5d29",
"account_manager_user_code": "sample string 56",
"company_status_id": "38a3384a-a5a5-4600-8cb5-f0d33883514c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-30T07:19:32.7002387+00:00",
"id2": 60
},
"db_language_id": "0bec1dac-0482-4e53-bbf7-71032f62a96b",
"db_language_code": "sample string 7",
"db_title_id": "c698222c-59b7-43b9-bb11-8316a0c7e5e0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-30T07:19:32.7002387+00:00",
"create_date": "2026-05-30T07:19:32.7002387+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-05-30T07:19:32.7002387+00:00"
},
"modified_dateutc": "2026-05-30T07:19:32.7002387+00:00",
"id2": 22
}