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": "0ab80c25-c4f9-4bf2-a2f0-d1a6fdfd602c",
"_parent_id": "c5b10ddc-f78d-41df-8cb1-aaaca01f7fcd",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c371030e-25d7-4763-ac1c-7d1711547db2",
"company_id": "64021386-7754-4ca0-b285-684c960c0541",
"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": "f76d5369-966f-4245-93e8-860c40edc112",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c210b4dc-3f9c-496e-ad43-d047d5fdf3f1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0d104fac-cd90-4efd-88ad-a1af5689d395",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7df5c67e-bd73-4302-b88b-b35cf27aad7f",
"company_code": "sample string 5",
"company": {
"id": "c2b933cf-4139-492c-b458-9c84fcb0b983",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-13T00:16:00.6735115+00:00",
"sales_territory_id": "26e270c9-1aea-49ec-839b-7aa03046aa1e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "271221a0-d918-428f-88a6-23ddbde34b08",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d5a6ce65-6d0c-405a-87d7-dadd5421e8d8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ce0bf6ca-6b7b-43b8-8f07-8de77765c640",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f4f9591-bfc0-4716-a594-352b388f989c",
"db_currency_id": "6d2a7b21-76bd-4d02-8f31-e479f48d4a6d",
"db_language_id": "1d26f4f6-b792-4299-a234-d8a04da33f15",
"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-13T00:16:00.6735115+00:00"
},
"modified_dateutc": "2026-08-13T00:16:00.6735115+00:00"
},
"marketing_segment_id": "4278926a-1f05-43cd-8efb-a72b476643a4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "35023571-aa72-403b-a3e3-5f9c7e8c076f",
"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": "b325a4f9-71fd-4a72-a358-276781e810a1",
"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": "f037becf-2550-4f8a-bd59-20170e25b58e",
"db_country_code": "sample string 28",
"feelist_id": "9d852fe1-20a1-4061-a7a9-a917100f7edc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5ee7241f-6de1-4a7d-8eef-e1744936d393",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2c1e2f37-8085-4f2d-a227-87c4b02ec0a2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-13T00:16:00.6735115+00:00",
"db_currency_id": "6d00add8-601a-4900-add8-fd4a9720cb31",
"db_currency_code": "sample string 10"
},
"company_type_id": "5c99644f-f9f8-4e16-85ac-1752ee4e0000",
"company_type_name": "sample string 32",
"company_type": {
"id": "299bc200-a2ed-4d96-981d-ef33facb0704",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fa9c3b45-ea59-42de-a824-e5fc40d6ace4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c51fe6fb-9243-4f40-b30e-20b18a00c1aa",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "063d646a-48a1-4ab5-ab51-30362103502f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "022cdc67-6660-44a3-86cf-63ab6af6b58e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0cb16c52-9b89-4b9a-a674-5db690630991",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-13T00:16:00.6735115+00:00"
},
"company_sector_id": "c9fe3b2a-301e-4f03-8678-a21f753d5ad1",
"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": "8bcf5dd1-e908-4c34-a6cc-14e435f6a4c7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e05c7c86-39e6-4a36-bcb1-d8ca36621852",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "55fbbe75-9a00-42ff-b440-4b1a735a09b9",
"account_manager_user_code": "sample string 56",
"company_status_id": "0f77daeb-9e1b-4474-b215-dc18c08243b8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-13T00:16:00.6735115+00:00",
"id2": 60
},
"db_language_id": "954c3882-501f-42a5-9c4d-bf0cc78c60b8",
"db_language_code": "sample string 7",
"db_title_id": "aa09823f-90fc-4118-b9bd-4b38c0fa0c09",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-13T00:16:00.6735115+00:00",
"create_date": "2026-08-13T00:16:00.6735115+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-13T00:16:00.6735115+00:00"
},
"modified_dateutc": "2026-08-13T00:16:00.6735115+00:00",
"id2": 22
}