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": "9e60561e-e7aa-4cc4-bf79-4a29ccad2455",
"_parent_id": "034a1082-aa15-4d34-88a3-16fa49608e7c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f8ff7db4-005b-45ec-91ad-96af22904d72",
"company_id": "294bbd35-0492-45e9-b7b0-e450ffb515ed",
"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": "9a68c82e-013f-4505-afbb-600b0f6b18f0",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "7d4e69ac-5a3f-43fe-8cfb-6ff54e7cf317",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "bc65a562-a6c9-44b6-a973-f411c0ce67ea",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d8fb1821-7423-4c70-ab5f-239ed30b9380",
"company_code": "sample string 5",
"company": {
"id": "17468e15-43f6-482e-a42c-63e697c723ce",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-09T20:29:21.9530214+00:00",
"sales_territory_id": "d6fbcbe8-505d-4c03-b423-75fda0824489",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d028830e-38c2-4ac5-9852-3e8f2e6f8710",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8ca6b4b7-6117-446b-b222-2989193be8e9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8c5c529d-ab23-42c1-b44a-8181d596207c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a52f254b-5434-43a4-ab7d-694249c48d1e",
"db_currency_id": "5d68dbd2-79e1-40d5-9067-5c530cf05635",
"db_language_id": "0c90f0ed-4a2e-4372-90b5-a9c61b5c8a23",
"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-04-09T20:29:21.9530214+00:00"
},
"modified_dateutc": "2026-04-09T20:29:21.9530214+00:00"
},
"marketing_segment_id": "149f2cbd-4b4f-4e7a-a65c-6ef787e97ab9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "48b1ddef-cf45-456a-9bbe-6a1b884add0a",
"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": "810ce39d-7f69-4404-a82c-e6b9413554d4",
"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": "b2e621f2-0237-40e3-aaa6-236d1c1b728b",
"db_country_code": "sample string 28",
"feelist_id": "f0d5be2e-ca54-4ec9-985d-24ed7d0c10f1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "93b25093-db0a-461b-8775-e639f3acde2a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e5d6f2a7-f0fb-4b83-8952-7b601d041bf2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-09T20:29:21.9530214+00:00",
"db_currency_id": "626e1bc8-934e-4fb6-9a47-9742fd5c8fae",
"db_currency_code": "sample string 10"
},
"company_type_id": "36f88663-615f-48de-be6a-9fd6591fe421",
"company_type_name": "sample string 32",
"company_type": {
"id": "1b52c662-02be-4f5b-8dda-74ee144f3568",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1179eaaf-3fbb-434a-8712-76da89b194cd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ccbebadb-617e-44dc-b6fe-ec59d53f9363",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a8afcc4c-d16f-4e37-a985-4ecb513eeefd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "18edd9ea-4eaa-43ca-90d3-1852ddaefab9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ce017071-67fb-4887-a3e6-9ca8a343003e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-09T20:29:21.9530214+00:00"
},
"company_sector_id": "4e32207e-e6b7-4ef1-bac7-e7707da44722",
"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": "ba688fbf-e564-4dab-9e9d-ed9a8c07529d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ca97f607-8866-48c6-8252-86ad0e6e38ce",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cdc396b8-d573-4cd1-8b1b-4bf7bc747ee8",
"account_manager_user_code": "sample string 56",
"company_status_id": "702b0cc2-9db4-4553-84c5-7247f5ced506",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-09T20:29:21.9530214+00:00",
"id2": 60
},
"db_language_id": "c6c2eb7b-1553-4653-a94f-ebdd37a3562f",
"db_language_code": "sample string 7",
"db_title_id": "20a65709-0c18-4914-9e92-f87758573817",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-09T20:29:21.9530214+00:00",
"create_date": "2026-04-09T20:29:21.9530214+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-04-09T20:29:21.9530214+00:00"
},
"modified_dateutc": "2026-04-09T20:29:21.9530214+00:00",
"id2": 22
}