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": "a876acd9-5f29-4657-a962-09a98f1d8607",
"_parent_id": "cf905d92-7412-43fb-8271-9c9ddfb8de0b",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "82beed02-7e45-449c-80dd-d1bb8d1a01b1",
"company_id": "877d5970-88fa-40fa-b258-a282cd2f6ae6",
"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": "4a7a9076-13b4-4e4a-8c98-023c6c2d983d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ed1540d5-596e-4567-be3d-9212b082c6c4",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "16ae1723-f068-4115-96f2-d507838ca734",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1be3aeb9-fe41-4f3e-8dfa-3ae256a68a2c",
"company_code": "sample string 5",
"company": {
"id": "714dd3a5-1f5b-4e1f-8097-a2237096d0e6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-12T05:09:46.60097+00:00",
"sales_territory_id": "307f65ca-4624-4131-853a-1ff78a161344",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cc75a180-3524-4fb8-b981-acb0654f0a25",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a5bf1d8c-b2ad-4ab8-97c4-65bffd68ea11",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a731394c-aac4-4b02-8b05-3e53cb388429",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0788e539-774b-416d-885d-f2b9339320e7",
"db_currency_id": "2deb07af-e4b6-4ea3-bec1-a4281c2360cb",
"db_language_id": "2497e901-d9a0-4bf4-a34d-7f615743973e",
"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-12T05:09:46.60097+00:00"
},
"modified_dateutc": "2026-08-12T05:09:46.60097+00:00"
},
"marketing_segment_id": "c9731d54-3aec-4811-b566-b9b5ad81a316",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "aed7556f-891a-465a-9bcc-95905b84b9f6",
"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": "1b2fbf38-1c8e-41ae-adf2-aa38e9c96a2a",
"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": "b6890eb4-5f8f-4a20-b6a0-67e2a443502e",
"db_country_code": "sample string 28",
"feelist_id": "38a68206-5475-4f56-8bdd-3cb293b5ef92",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "34168541-6c1f-4695-95cc-a50c64520a6f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cc1d1211-a612-4022-bfcb-b962eb92bfa8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-12T05:09:46.60097+00:00",
"db_currency_id": "784142e7-14e3-4d67-a2e7-3bb324db45d8",
"db_currency_code": "sample string 10"
},
"company_type_id": "eb18e638-84a9-46c5-8c3b-f998c3c0a663",
"company_type_name": "sample string 32",
"company_type": {
"id": "40e2b3d5-60db-4d66-ac4b-1774395479d3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c81f334f-d340-43c4-b211-ca891c78693a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1cd5dcb6-3d9d-433b-b281-082042789ac1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "01eed570-bbc3-4cdd-9959-567fa2de24df",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1e0c6487-e1fc-4934-84eb-0fa7e03b0483",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "91f66925-dbc0-4086-b3eb-92fa32d68b4d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-12T05:09:46.60097+00:00"
},
"company_sector_id": "2ac2e634-0d6f-4e2e-a0c3-13d4059034bd",
"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": "0c925aa7-7d67-42f0-b75d-ae706030df48",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "75b1a664-7c3d-4024-adc5-9b14eee92003",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "193480d7-d2cd-4bea-99c9-d90660f81dd8",
"account_manager_user_code": "sample string 56",
"company_status_id": "bd0b7aaa-5048-457b-bf43-0ab3b22ec0c1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-12T05:09:46.60097+00:00",
"id2": 60
},
"db_language_id": "ab77888d-d5a5-4161-bde6-2b65a7ceb68e",
"db_language_code": "sample string 7",
"db_title_id": "042500ba-7a3c-4052-a427-7d016103cdca",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-12T05:09:46.60097+00:00",
"create_date": "2026-08-12T05:09:46.60097+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-12T05:09:46.60097+00:00"
},
"modified_dateutc": "2026-08-12T05:09:46.60097+00:00",
"id2": 22
}