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": "c1603a0e-118b-46a2-bfa9-ae36b3dbe8ef",
"_parent_id": "a63d1c8d-d933-4e6a-97f7-4e3ca695f9ce",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "044d130e-6c02-48ef-b4c3-151095a79b76",
"company_id": "428a5abd-3e5c-4731-a03a-5af574546fdf",
"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": "4133dca6-c571-47bf-9bc7-8c09b2981c0d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "fc4a1357-5405-4185-b321-50760fcf6a35",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "b8073772-9fcf-481b-9dcc-27b641a108a6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "892e671b-afb6-4731-9774-7d77cab9c886",
"company_code": "sample string 5",
"company": {
"id": "f2521423-c6ca-4615-8c8c-74b1cedaf526",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-01T19:22:35.4051848+00:00",
"sales_territory_id": "6bc77073-6a30-4d51-9dbd-bd87f6030523",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "549ab855-2737-46d7-a3cc-11703422c89b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "18e77284-a160-4091-be7b-de9934f4f552",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7321e9ce-9cec-4c0d-b30c-66f4f1aa7d83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d1a201e-f4cb-4d73-a789-2837216da3b6",
"db_currency_id": "c6288e8c-ebd0-44fd-b90e-e55ce00bf3a8",
"db_language_id": "40275fc4-c303-436b-9a7d-84a857bfd003",
"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-03-01T19:22:35.4051848+00:00"
},
"modified_dateutc": "2026-03-01T19:22:35.4051848+00:00"
},
"marketing_segment_id": "a013396d-3626-48b9-b5f5-cd77d60ba051",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "69fe23b6-443d-499d-b7de-5b0a11dfb30c",
"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": "b8faf263-aa76-4677-83fc-16c14b9828ea",
"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": "f4f44a2c-c292-4059-9e22-73ea3bc94808",
"db_country_code": "sample string 28",
"feelist_id": "ec43165e-7c6f-4972-937e-08ed5940f328",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "01dc4916-6cd1-4749-845b-3ba619c6c968",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d0a4a5b0-40f9-4922-8fdf-b8ffcc9d3371",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-01T19:22:35.4051848+00:00",
"db_currency_id": "e96fb229-f216-48f1-b08f-eca7392576d4",
"db_currency_code": "sample string 10"
},
"company_type_id": "7d851804-468c-41db-a290-4b15a660fb59",
"company_type_name": "sample string 32",
"company_type": {
"id": "d1a6d3de-6763-4c7b-96fc-447bf654ac5a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "edb83e11-1331-4707-a25a-653f07a86271",
"sales_organization_code": "sample string 5"
},
"db_language_id": "47454824-6173-4ba4-9652-ebb523444a71",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "232430a2-7ef1-45b9-822a-dbe375aa6108",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2695acee-1467-44bc-8dfa-31cbc4106cd7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d7523f41-feab-4a36-acb1-9c5926bcc0ff",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-01T19:22:35.4051848+00:00"
},
"company_sector_id": "68a6129c-2b2f-42e1-8f10-8f9f09692abd",
"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": "6f98f5eb-c91c-4531-b0d8-c84d94360e3d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cbbefff0-5e76-4c53-a425-75d4a55c2511",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1cca89d7-c664-48ec-99db-aadf9b3b623f",
"account_manager_user_code": "sample string 56",
"company_status_id": "41c7c841-2825-489c-a4b4-11367333e22d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-01T19:22:35.4051848+00:00",
"id2": 60
},
"db_language_id": "f05ac37b-e9fb-41f4-8c56-52e0c9c29ef2",
"db_language_code": "sample string 7",
"db_title_id": "8965de49-b491-4329-a30d-b4105ea3fc43",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-01T19:22:35.4051848+00:00",
"create_date": "2026-03-01T19:22:35.4051848+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-03-01T19:22:35.4051848+00:00"
},
"modified_dateutc": "2026-03-01T19:22:35.4051848+00:00",
"id2": 22
}