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": "807a04d3-8157-4423-a162-a2308aa17018",
"_parent_id": "a76740bf-833c-46a8-ba78-5de4466293f7",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6807645e-e3ad-4a0d-bc3a-7e4e561ef19a",
"company_id": "4fbaa86f-f3ba-4e64-ab2f-500a8f793bb8",
"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": "e3477752-9c1a-43c3-bcc6-c480192d3438",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b891b482-a951-431b-821f-a924cfeb00ad",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6cf725e0-b298-498b-8df6-44d18d53793b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4f560b66-c347-4085-95bc-5bc0ac0278ba",
"company_code": "sample string 5",
"company": {
"id": "67691f3d-3517-440f-b915-8d68df5bd82c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-02T14:21:13.0008672+00:00",
"sales_territory_id": "29e90431-e262-4c83-829b-f09964b489d8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "71655421-dcfd-49e3-8893-2046b3453734",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "824667f4-0139-4701-889d-94bd4ebddd41",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7e425be1-1f1f-447b-bc20-e9d1ea225c1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7857208-e30d-44d0-a59d-47bd4881d0d6",
"db_currency_id": "5690a186-b509-440c-b46f-5c0c929bf759",
"db_language_id": "8b7f8f72-3e76-4ed2-a785-48d32588ba1f",
"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-02-02T14:21:13.0008672+00:00"
},
"modified_dateutc": "2026-02-02T14:21:13.0008672+00:00"
},
"marketing_segment_id": "1a723ae1-ca38-4bbe-917a-9dfddfe1ed23",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e8fbd8a0-f484-41c4-806e-f854cd407e53",
"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": "ebe72ff5-369e-465b-9e1d-85f7b7c7bd87",
"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": "dd1d4c51-3686-43a5-a5f9-52991dc515b5",
"db_country_code": "sample string 28",
"feelist_id": "3b99ee4e-a269-4a8a-b9fb-4f6e6bf46416",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "967edb46-666b-40b0-b6cc-bacc2966c26f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e5eb1388-4082-4c86-b370-365bc1b1e55d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-02T14:21:13.0008672+00:00",
"db_currency_id": "b6cd1435-05a3-47fb-af8f-7663cdbcda7f",
"db_currency_code": "sample string 10"
},
"company_type_id": "b8ffd2eb-0fce-4cc7-9b19-6903f3f43973",
"company_type_name": "sample string 32",
"company_type": {
"id": "1b8cc107-d053-40e6-a8ae-0854bf9e22fd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f0fd8776-4c74-4c05-9102-f5700830a7a6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6864f1be-b67d-4516-b679-005594f68ae6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a57214ef-c204-46ef-8393-d093c915eef0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9ed85a99-5f18-451f-a3f5-8f6d3ee100a0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "168d5848-20c7-4ee1-bd00-e57f35c77fe2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-02T14:21:13.0008672+00:00"
},
"company_sector_id": "aae37ea1-be1e-443b-b887-5aa562dd5196",
"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": "47caab52-991e-4413-9476-b6d2aa53ca9b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fa7bb7c5-a00b-4458-8875-dec04d0aed6c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "16a19b5e-996a-41c1-beae-10ebc1f98796",
"account_manager_user_code": "sample string 56",
"company_status_id": "894bc76f-d54e-4399-8553-49f16179efcd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-02T14:21:13.0008672+00:00",
"id2": 60
},
"db_language_id": "89a678ce-6716-4960-8c02-ae79be504bf5",
"db_language_code": "sample string 7",
"db_title_id": "f899e41a-be75-4e4a-a904-5b5c5e09450f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-02T14:21:13.0008672+00:00",
"create_date": "2026-02-02T14:21:13.0008672+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-02-02T14:21:13.0008672+00:00"
},
"modified_dateutc": "2026-02-02T14:21:13.0008672+00:00",
"id2": 22
}