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": "d0146067-90d8-4626-b2d9-945b132ab50b",
"_parent_id": "cc3b5989-cca0-48b3-a2eb-6145e8690757",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "7eb4e714-975a-4de5-91a0-0a1a18abb6d7",
"company_id": "61dd4afb-8deb-4d3a-91e6-b998c5120114",
"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": "5b447a99-fc70-4a94-a5e2-355ae5b1b5b3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3ae89eb6-f9ef-4e05-b706-628cb9f4a213",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "988d2560-58b7-4303-9a67-6675a0fa8402",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8eee0822-b97a-41ee-bb5d-52668675c0b4",
"company_code": "sample string 5",
"company": {
"id": "89e781e4-ba7b-45cb-ad55-1c2f7ee26a47",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-22T03:54:35.0122945+00:00",
"sales_territory_id": "0b6c0bfc-d1e1-406b-bde0-61c87c30c92a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "01ab0fc1-df59-452a-9f84-f05e1dc88ea4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "39f16930-d9e2-478a-ade3-0ed4c7b396bc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b1964688-d3e3-4eba-a60b-2f3cdcab7ca3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c9fcf70-5c02-44d9-99f4-16841e522d3f",
"db_currency_id": "3eb2c8b7-4eaf-494b-b4b2-b48c16d581e7",
"db_language_id": "e1ea96de-9021-4bd9-87d9-607137f84b6d",
"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-22T03:54:35.0122945+00:00"
},
"modified_dateutc": "2025-11-22T03:54:35.0122945+00:00"
},
"marketing_segment_id": "48dd3980-9371-49ee-baaf-5d4d0f03871e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "aedb9ef9-782e-4f3e-9a85-cb0086cb3965",
"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": "bb378804-7f80-48bd-a1fa-1fa9ff2aa499",
"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": "352df137-e8f6-43c0-bbef-18f2495bdad9",
"db_country_code": "sample string 28",
"feelist_id": "d5f226a6-2b55-4cff-82fa-1a85ca7b0e69",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b7acddb2-eccd-4576-8ef8-c6eb7f53cb12",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f4e0043a-fc93-46cd-99db-e4085d0cdea8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-22T03:54:35.0122945+00:00",
"db_currency_id": "0f071bb1-0c34-492e-83f7-012a69799a90",
"db_currency_code": "sample string 10"
},
"company_type_id": "022276e3-8df8-42d9-97ed-72462f93dda5",
"company_type_name": "sample string 32",
"company_type": {
"id": "9873d56c-3b1b-470d-b198-1aa786a901e4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e9cfe7af-9d67-42e3-9c8c-093a0e131ada",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bf292c2b-2405-47c9-892f-ccc8c1ab6996",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d8eb2efa-e7c3-48b8-9e22-f017a6ae69cb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2b38e3c6-6166-469e-b6fd-2ac8a98df351",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fb0a4605-ec35-4aea-a374-e3c78924b292",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-22T03:54:35.0122945+00:00"
},
"company_sector_id": "43ecbb76-092a-47aa-807c-ace09a40f5af",
"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": "7bef6801-3d17-4520-8849-8f30fc9f8116",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cad48389-62be-4625-95eb-a0a574ad162d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f4b0c9e8-02ad-498b-b2fe-648af6db9222",
"account_manager_user_code": "sample string 56",
"company_status_id": "7341a1e4-69cb-4b38-9754-e82874a0ad9e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-22T03:54:35.0122945+00:00",
"id2": 60
},
"db_language_id": "36e9cb28-5e81-41f9-88e6-04718a54678a",
"db_language_code": "sample string 7",
"db_title_id": "50ce0c56-f583-4464-b8f4-51126dac857a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-22T03:54:35.0122945+00:00",
"create_date": "2025-11-22T03:54:35.0122945+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-22T03:54:35.0122945+00:00"
},
"modified_dateutc": "2025-11-22T03:54:35.0122945+00:00",
"id2": 22
}