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": "ad11b546-e710-4130-aaf6-386362d0e076",
"_parent_id": "e6cfa646-1da3-43e4-8e3b-1e3e3c6b149a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "8c489690-b00a-447b-89bc-9111d9f4e085",
"company_id": "85b36163-c694-4fc5-bef7-4dcf8ac60e6c",
"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": "8fa02fbb-cf3c-40ef-b642-85fde72978dd",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a9ce608c-2f45-4cc4-bb7a-ae1d09be1367",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "1772301e-da06-4618-9d04-f5029ecf5981",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5cc68edd-8ae8-4231-b212-f171ba46fdf0",
"company_code": "sample string 5",
"company": {
"id": "eefebee2-8af6-4aaa-811f-35f23bfe8c62",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-08T22:35:52.032383+00:00",
"sales_territory_id": "285cfa39-e09d-4c69-916d-41d76088248c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "55c9cb26-c850-45c6-95bb-b88b9475a737",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "499b2a66-e1a2-41fd-bb7d-e6e37ed7ab81",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "27e18bba-3b78-4ed8-bdb7-8da0b430a463",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0826aa48-cae3-4595-af6a-987d6375afeb",
"db_currency_id": "b7ed8209-0324-4206-b92d-3d2fe33605c5",
"db_language_id": "6b8a32bc-c846-4096-adaf-70c9f9c8db24",
"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-04-08T22:35:52.032383+00:00"
},
"modified_dateutc": "2026-04-08T22:35:52.032383+00:00"
},
"marketing_segment_id": "f2a9b4d0-b5bc-449c-8c21-827adbb5f332",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e87ba716-8250-45d3-a93d-64573f1b3765",
"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": "c90f0662-8180-402e-b621-c0087ee615e8",
"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": "2764c587-2d96-4355-8f5d-a709d350a67a",
"db_country_code": "sample string 28",
"feelist_id": "95325221-5d8f-498e-b22a-a162997b9582",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8c32ed91-5520-499e-9a0b-0d83399e92e9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8423df86-37cb-46ab-b5ed-7ddc9f5b3ff6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-08T22:35:52.032383+00:00",
"db_currency_id": "b77e31bc-3361-45ab-ba8a-3c3758a91a1b",
"db_currency_code": "sample string 10"
},
"company_type_id": "bef053d6-ccce-49f0-8477-38ea783ec8e4",
"company_type_name": "sample string 32",
"company_type": {
"id": "d5f6bfdb-a632-491a-8eb2-26b577f8a7a4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "928fdf38-f1de-454c-9bae-79c58457cc76",
"sales_organization_code": "sample string 5"
},
"db_language_id": "246f0f37-af8d-4b13-be88-d936e99d4299",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f5c5e0eb-7428-4713-aefc-970669e396ef",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8160246f-770a-4019-9943-1e6a0f8be170",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a35f9bac-9ff4-478b-bb7a-0f9f3f1de2f1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-08T22:35:52.032383+00:00"
},
"company_sector_id": "c362fea5-3897-47fa-85d5-480beacc2f01",
"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": "d474eb3f-674e-4162-8fb7-6419d08b25e4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fcebe5ca-048e-4486-8fb6-f444b60f2554",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0b5d24a5-1bbb-4409-beb7-b5f3f4cf3c1c",
"account_manager_user_code": "sample string 56",
"company_status_id": "1199f0dd-164c-4c19-93b0-30f298738f9f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-08T22:35:52.0479891+00:00",
"id2": 60
},
"db_language_id": "066c4352-4a9d-47f8-a245-f4bf5eaae1fb",
"db_language_code": "sample string 7",
"db_title_id": "6c32a44c-80f1-4d74-9b5d-a67a6a421f57",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-08T22:35:52.0479891+00:00",
"create_date": "2026-04-08T22:35:52.0479891+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-04-08T22:35:52.0479891+00:00"
},
"modified_dateutc": "2026-04-08T22:35:52.0479891+00:00",
"id2": 22
}