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": "a9e21e1a-5a55-4e54-ae5d-e9732fcce517",
"_parent_id": "4ae27edc-a8ad-406d-b02f-d99cc0e0e234",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a5ef47e0-52c2-46a8-9150-09bcbedda506",
"company_id": "6e4aa239-fc0b-4000-8e39-11dcfe433ba4",
"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": "3b9b16a9-4e2b-45e5-93ce-fe0e0b6d04a6",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "aa0a578a-add1-4d3d-ad51-133a939dd73b",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ef7e472c-e162-4d48-a796-f016df194612",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7a1c348c-742a-4332-b11a-74c72a0d52f7",
"company_code": "sample string 5",
"company": {
"id": "51a01935-fd3d-4398-9271-93925f942cb5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-08T06:45:07.1500016+00:00",
"sales_territory_id": "007130b9-be89-407c-8c9f-a8f82840612e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "44e8906c-1a3d-4eaf-9e0e-2078d913857a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b276f4f0-ea99-42d3-84f0-f43893e6b47c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "26539862-d6a0-474e-9a9f-1fd1d520e4c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09d292f3-05e6-4c19-8ef9-5c040f2ef5ef",
"db_currency_id": "011d1f24-6bb0-4f08-8f9b-9e368821ab36",
"db_language_id": "54f8f6f1-427f-4356-b20e-85118b26aa20",
"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-08T06:45:07.1500016+00:00"
},
"modified_dateutc": "2026-03-08T06:45:07.1500016+00:00"
},
"marketing_segment_id": "fcc6d896-e37d-4bb0-bb58-9d201cd46eb0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4ffaad38-75c1-40c0-99dc-d34bd022241b",
"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": "a7319adc-2c0b-4559-bcac-f06f0f0e8df9",
"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": "44f2d405-b0ec-4b77-aa24-b248d89c442e",
"db_country_code": "sample string 28",
"feelist_id": "56d9b69a-cbfd-471d-aa9c-1a37c4b1683a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "17498e81-d207-40df-9d32-f38bb7bed54a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7343a1db-3875-4f36-b876-6231b68ee8f6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-08T06:45:07.1500016+00:00",
"db_currency_id": "bf21144c-129f-4144-8831-32066a2e58d8",
"db_currency_code": "sample string 10"
},
"company_type_id": "2096ebf0-329a-42d2-9153-51bada965a56",
"company_type_name": "sample string 32",
"company_type": {
"id": "297d54d6-66e5-4a80-a223-d29c9616b7c5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2153fcad-2a1b-4e71-9ab5-2a3bf7af896f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c69ca8a6-e9ec-4272-af43-2711f65dd014",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3e18293a-8780-4665-8439-8d3b19aadfd4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8646e49f-d483-44f7-b387-fa7ded05d6b6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c0eae582-bcff-4031-a542-b67750ceb59e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-08T06:45:07.1500016+00:00"
},
"company_sector_id": "ef0510f7-9927-492d-b289-b9424d466c35",
"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": "dbc0fb02-c343-4d02-a0b2-42252f7fb655",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fa75ee73-265f-4e4c-bb42-543e46432a09",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d04f8c7c-174d-4179-a39c-b309e357e07b",
"account_manager_user_code": "sample string 56",
"company_status_id": "1bad6e51-d63e-4760-ab72-b2d628eb4d4b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-08T06:45:07.1500016+00:00",
"id2": 60
},
"db_language_id": "75defa44-0beb-427e-91c0-5031a67f216a",
"db_language_code": "sample string 7",
"db_title_id": "6d2fb7fb-88ec-4a23-b005-29f84d255506",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-08T06:45:07.1500016+00:00",
"create_date": "2026-03-08T06:45:07.1500016+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-08T06:45:07.1500016+00:00"
},
"modified_dateutc": "2026-03-08T06:45:07.1500016+00:00",
"id2": 22
}