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": "599ee292-433c-43a9-a267-a12e199f1ee1",
"_parent_id": "f296e6f5-6ec1-4617-b728-733add8b1660",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "33b38e82-940a-4a23-9052-6ab0e00c4aea",
"company_id": "fe89e5a4-a0e0-466b-8863-c25a8fc5d5db",
"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": "aaf3c122-c7b4-4354-8f3f-595d556ebc80",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "5339b23b-6619-4852-bb77-2d1e839facd0",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ad3f786e-9a63-496f-b3c7-4a913d387489",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "538d98e5-8860-4685-9ee6-9154ab64e4f2",
"company_code": "sample string 5",
"company": {
"id": "83d0bf1c-4bab-447b-bbf2-1c32b058511d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-22T08:48:14.3082388+00:00",
"sales_territory_id": "04ff0307-322f-4f50-b187-749a31c2d9ac",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1c243e07-bba8-429c-b9d7-0f30dc703ee8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b8512ac3-de61-42dd-a2a1-6ae80c5bfb7e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9d122e2f-9877-423b-9803-7c109df32705",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a373565e-b52b-45a4-830d-86595d030229",
"db_currency_id": "4c845396-78cf-42e6-bd34-1033a97eb112",
"db_language_id": "c09a5dd3-ed30-4031-a378-e43faf89162f",
"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": "2025-11-22T08:48:14.3082388+00:00"
},
"modified_dateutc": "2025-11-22T08:48:14.3082388+00:00"
},
"marketing_segment_id": "63c97a47-f4b1-4c1d-bddc-89419fc82e17",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4d0305a8-0771-40a6-bc94-1d7627dd1f91",
"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": "0ee0f3d2-e9f3-4ebf-ac52-87dc2ac780a1",
"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": "3c182d60-1bbe-4b41-8b05-395f765efb08",
"db_country_code": "sample string 28",
"feelist_id": "a8a7f8c7-4b16-4763-aead-6d75cbb2b520",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "56c8571a-339a-43ac-a817-d183f82171e6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "966c9868-3779-4d40-b222-c7a1c620622a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-22T08:48:14.3082388+00:00",
"db_currency_id": "f81035e1-e5c7-4de4-9674-c533ff40d7d8",
"db_currency_code": "sample string 10"
},
"company_type_id": "b1172d1a-3a26-4951-8aa9-18b4f52bcbc7",
"company_type_name": "sample string 32",
"company_type": {
"id": "0dfe0109-251a-4db0-8334-be42bf4199b2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3270f095-8986-4ae6-a753-e8c7470d19f4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8cd1a0cd-8c55-49d0-b46e-ec68a06c0578",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "27d5da1d-b5e2-4f57-8b77-4f4de0fcbd05",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "43fff012-b93e-43fe-bf9e-19240174bb3d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bec7ac35-d7f4-4c11-bb5d-3e489189a2a3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-22T08:48:14.3238657+00:00"
},
"company_sector_id": "7776caf7-85ce-4e60-bcf7-bc8e4619037c",
"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": "c87ce275-9d3b-4b15-8780-83a6dc0d82ab",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f97e561e-abd4-47fc-9a4d-e92c1bbc77c5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3d29abf5-bc19-4def-a8a3-5f89394bdf4c",
"account_manager_user_code": "sample string 56",
"company_status_id": "a082814e-f339-468f-8d0d-feae1d4f8ba2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-22T08:48:14.3238657+00:00",
"id2": 60
},
"db_language_id": "40966724-902b-4de9-8a37-6ec7941586e5",
"db_language_code": "sample string 7",
"db_title_id": "5806eb43-3721-43bc-9d5e-8b8596e28a65",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-22T08:48:14.3238657+00:00",
"create_date": "2025-11-22T08:48:14.3238657+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": "2025-11-22T08:48:14.3238657+00:00"
},
"modified_dateutc": "2025-11-22T08:48:14.3238657+00:00",
"id2": 22
}