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": "ea246919-61f3-44b4-ac8c-91bca98a2272",
"_parent_id": "36d0f68b-8830-46a8-b6f3-119817081915",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "bfbdcb4d-5ae5-4bac-a0e7-0f67b05ab549",
"company_id": "5f308a04-6c36-47b9-bee8-c9686481f6f4",
"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": "56e461fb-6346-443d-9cb4-978f55491c37",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3148a422-4d33-4630-8add-fbda51bf2b3c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e4f7efd8-cd08-41ca-a48c-861c1235468d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "39e03094-fa1c-425c-bc9a-e6634a7a056e",
"company_code": "sample string 5",
"company": {
"id": "64ce4b19-cfe6-46eb-b43e-49ae13517023",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-04T06:19:16.009245+00:00",
"sales_territory_id": "02913c79-e824-44ad-ac2c-bea2b54d598a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c0748342-6f68-4bf7-ac89-0a9b623f9b61",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1b7cc02b-7ce5-4fee-b4fc-9a91392591f2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "efa7087f-2f1c-41e7-a149-4c6f546c2fb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6b7f1214-dbe4-402a-b321-d0dd1f9047db",
"db_currency_id": "a618aaf6-1806-430d-818c-6c4519b7a9c7",
"db_language_id": "1a65b6b1-ed3d-4656-b6d6-33e1820670eb",
"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-04T06:19:16.009245+00:00"
},
"modified_dateutc": "2026-04-04T06:19:16.009245+00:00"
},
"marketing_segment_id": "51412dd0-5b2b-4320-8ae6-e3cac6b9fb1d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7caac637-68af-4f31-a09d-dc1720951b0b",
"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": "a5cf084e-1119-4254-bd01-33bead989c8d",
"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": "4ffa5023-08f6-47db-bb00-818b038c558e",
"db_country_code": "sample string 28",
"feelist_id": "89cad875-5f2e-4f7e-944c-750992e70a1a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "57d95f2d-ffb2-4b06-b1c0-6b16593f1858",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "01214d53-962b-4c95-ab46-17f045437287",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-04T06:19:16.009245+00:00",
"db_currency_id": "8ec95c5a-a606-4531-b225-9f1ed545a536",
"db_currency_code": "sample string 10"
},
"company_type_id": "89116034-414b-4482-8185-c43f9b9a56df",
"company_type_name": "sample string 32",
"company_type": {
"id": "0e431791-2566-44c6-afa1-66f9e40e38c5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "197feaf2-a09c-4eda-bb24-9ff4a4029827",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7852a70f-6b3d-4e2d-b89f-7ea89263d847",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bac4b911-0e9c-46ed-add2-ce7a339269b8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a14f31f4-e89f-48cd-b9dc-a45ecc05a9a1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "daa48d43-fd0b-44f3-a6b6-2b6b194924f1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-04T06:19:16.009245+00:00"
},
"company_sector_id": "9a89955f-93e7-4de7-a895-e753ae88ca6e",
"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": "d5ea2530-4093-4718-8ba1-92b2c4cf0181",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "41fd5b3a-e666-47c2-bbe2-4c83af87e2de",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "be368486-896a-43d5-b6dc-b194bfeed679",
"account_manager_user_code": "sample string 56",
"company_status_id": "b84268b4-9dc9-43fe-adb3-a175732d6d1c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-04T06:19:16.009245+00:00",
"id2": 60
},
"db_language_id": "58b0f397-65cf-4dde-9a03-d69546ceef9d",
"db_language_code": "sample string 7",
"db_title_id": "1b4078df-a4bd-41ce-b5da-55496a26223c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-04T06:19:16.009245+00:00",
"create_date": "2026-04-04T06:19:16.009245+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-04T06:19:16.009245+00:00"
},
"modified_dateutc": "2026-04-04T06:19:16.009245+00:00",
"id2": 22
}