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": "b21c55f0-4a52-4977-9cc1-70063ee9a645",
"_parent_id": "b3ee3cf6-08f4-42fe-ad00-2c648fd619d2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "98b1f2f1-d933-4c4a-97d7-b01666402e29",
"company_id": "0e7a13af-7653-4e49-ad11-239c8e57390e",
"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": "876e9dbf-a958-4126-b68f-9111b36f1fdc",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ed614776-244e-42e5-b835-9c4e47cc12e2",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "375de608-956a-4ee9-8a76-85844a94809c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "80cabeb7-95fb-4777-8161-6def378d7acb",
"company_code": "sample string 5",
"company": {
"id": "7ea4a248-052f-4ed7-9607-da82ce0d5984",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-15T12:45:15.5814216+00:00",
"sales_territory_id": "8a058b3d-8cc7-4f22-9a83-de4fec39c087",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "650fd86c-94eb-4d31-9aa4-245cfb8b7074",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "987b5b5b-d038-437c-aed3-52a54208ffba",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bcf96141-097d-465d-8d06-f4978946807b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab2e36ee-d775-4e13-9830-ba2cf2055465",
"db_currency_id": "75fe445a-497b-4f99-ba52-08e9c899e028",
"db_language_id": "470fe98a-d6e4-4c67-9aa2-6025d357bf78",
"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-05-15T12:45:15.5814216+00:00"
},
"modified_dateutc": "2026-05-15T12:45:15.5814216+00:00"
},
"marketing_segment_id": "b079043a-f96f-4980-86ff-b1f131462799",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a7af92a4-4dc3-48b6-8fb6-0f541d367e36",
"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": "5e76eefe-1624-4841-a2b3-ce84d8642f30",
"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": "55b5fb27-68ad-4761-a9aa-db8fe22711b9",
"db_country_code": "sample string 28",
"feelist_id": "d365cf9e-383c-4907-9450-97934b22591c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2573082c-37cb-4c5f-807b-19d6cb9e878e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a84a3f54-98f3-4bde-af2b-f781348a3256",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-15T12:45:15.5814216+00:00",
"db_currency_id": "9bf8e04f-32da-4141-bba2-6796b9a60c47",
"db_currency_code": "sample string 10"
},
"company_type_id": "2c392e3e-3cf6-4a50-bfae-06a7a403d9db",
"company_type_name": "sample string 32",
"company_type": {
"id": "1db2cf6e-9485-42a0-b026-8da651dc76cc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "af3749be-aa59-4f99-b624-76c5322a06cd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "14a3b3e7-3763-459b-be3f-c1139be3847d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "87b4f4f4-da98-4a52-9f59-80cfb3ce1602",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3ded0fbd-5baa-4acf-86b6-60f009b0ae92",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ab2cea54-415e-42bb-8f27-3738f5dfc746",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-15T12:45:15.5814216+00:00"
},
"company_sector_id": "d0187b33-fa12-4ec1-ba99-7a873ab529e8",
"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": "1fe7aaad-18d4-4c8a-92ac-5cf923552fd8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "168ebc45-a4b6-4aff-babb-5a2b98366934",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1ce80e2d-8f8d-4db9-b2ce-841b458e5564",
"account_manager_user_code": "sample string 56",
"company_status_id": "13d4db5b-7b08-40bd-aebf-0c1298082079",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-15T12:45:15.5814216+00:00",
"id2": 60
},
"db_language_id": "f2b1809b-b0c9-4fda-a104-9ddca31b5658",
"db_language_code": "sample string 7",
"db_title_id": "b7588e82-978c-4868-acf5-2ecf2cdf71f6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-15T12:45:15.5814216+00:00",
"create_date": "2026-05-15T12:45:15.5814216+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-05-15T12:45:15.5814216+00:00"
},
"modified_dateutc": "2026-05-15T12:45:15.5814216+00:00",
"id2": 22
}