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": "0b3a6339-0358-4d92-96c6-e1421900abaa",
"_parent_id": "8f3f918a-e455-47eb-b20b-2df9e128d6fe",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "049023ed-8f7f-49b1-aed8-c5d2c98b51ae",
"company_id": "6e513a35-8109-4fef-b4e5-1ce4dda56524",
"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": "77ddf371-b861-4b3d-8c64-9347a16cf326",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "020afbc0-0269-4a24-bd09-2b9249430486",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "cb3b64c6-1bbc-442f-ae00-8df3f032642b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b70374cf-a901-4ca2-8295-4b93b2cd2a33",
"company_code": "sample string 5",
"company": {
"id": "f2e572b0-f969-4827-bd1c-05eaf27146e4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-07T15:37:28.705449+00:00",
"sales_territory_id": "d8a55afa-1cee-4914-87e5-9464b99dd3f7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e9cd47d8-f675-4382-83fb-96a5f97090a0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "64363c9d-4864-40d1-b42d-fcbf45f4583c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "57ddb13d-af5a-402d-b016-f0c9618f418e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "07a0c226-504a-4fb9-aba1-d7a23b08a1e7",
"db_currency_id": "9e52269f-f313-4bbd-999d-79b5630c5a30",
"db_language_id": "102dea0e-3a04-465c-a384-b0a75747b4f3",
"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-07-07T15:37:28.705449+00:00"
},
"modified_dateutc": "2026-07-07T15:37:28.705449+00:00"
},
"marketing_segment_id": "e772f5ec-66c7-43ba-b885-9e08927dfad7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "695cfdd8-0827-48ba-9c6e-f71161bd346b",
"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": "154bc9bf-e460-42e2-90f0-31c901c257a7",
"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": "e723ee3c-f4eb-4515-b592-d2d2aa0068ec",
"db_country_code": "sample string 28",
"feelist_id": "0eaf0ad8-47ba-4825-8229-191201b2b5a3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "14d95a70-8177-4439-b0e4-1448e1e0a84c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b64c1bd6-536d-45a1-9f55-c9ad67e9d089",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-07T15:37:28.705449+00:00",
"db_currency_id": "54e8478c-1166-4cc4-8a9a-1db1ebc15621",
"db_currency_code": "sample string 10"
},
"company_type_id": "05578752-2f9c-4455-a569-faee8b3080ef",
"company_type_name": "sample string 32",
"company_type": {
"id": "f68078e1-b5da-42e7-a050-749faf2bcd05",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "aefd2c33-3d5f-4d2e-b7f2-90556bb5fa4d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5794ca38-d605-4831-b48f-2ec3705e25b7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fa97a665-a1a5-4155-9bcd-ef9b8b544e91",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "75b85b11-af1b-4e92-b18d-fbf2ba139dbf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4a1bc289-7dfc-4985-a946-18929dc85d04",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-07T15:37:28.705449+00:00"
},
"company_sector_id": "d983a93c-9502-481d-a1a0-b9e02fe45ae3",
"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": "366203cf-c7f3-422d-8912-6a7f3fae8dbe",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6a9bc082-4a0d-42c8-b29d-444b9f980998",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8ac9e9ee-f1de-4d05-aa47-91f212481dd5",
"account_manager_user_code": "sample string 56",
"company_status_id": "b3b40436-8ea9-4b54-b65d-36284b8f0d32",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-07T15:37:28.705449+00:00",
"id2": 60
},
"db_language_id": "4ce2ee38-0424-48df-a06e-0d81791138ef",
"db_language_code": "sample string 7",
"db_title_id": "ab331872-f8bd-4a39-b7dd-0e8af1000394",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-07T15:37:28.705449+00:00",
"create_date": "2026-07-07T15:37:28.705449+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-07-07T15:37:28.705449+00:00"
},
"modified_dateutc": "2026-07-07T15:37:28.705449+00:00",
"id2": 22
}