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": "f34154b6-0906-4f2a-a9f7-3b72c6154769",
"_parent_id": "df4fdbc7-e82a-4cda-86bc-df1d2c85f386",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "529a600a-17bc-46d4-9e00-771577b9c77e",
"company_id": "db9a0e46-4fac-4952-9238-136e1c2828a9",
"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": "e99b5d17-f3f1-4700-b8c0-6939f5341645",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ddefe9e8-68bf-4346-90e2-4006d2ca5a75",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "1a54b572-e2de-4621-965c-faf007b276ca",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "68e1b7f6-949d-4714-9ac5-ad23e177d1af",
"company_code": "sample string 5",
"company": {
"id": "c448c089-03f1-4da9-8f3c-9319eff4229e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-18T21:29:23.997855+00:00",
"sales_territory_id": "d0207fc7-cd13-4346-b1b0-1fd1de12cc9b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d68a5432-0c2b-47b3-a088-fbf2123f212e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fb5f1ed9-8d0a-4e3c-bd3b-795d1440af21",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f24c78fe-c3ea-433d-ba7c-1ab9478082f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ce2d97ea-0ab6-4b6f-a66b-dea3297eb0ff",
"db_currency_id": "d85b3074-a51b-4da6-9bc7-921aa5930b78",
"db_language_id": "279a7402-aadd-40ca-810f-a5b069a8c473",
"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-09-18T21:29:23.997855+00:00"
},
"modified_dateutc": "2026-09-18T21:29:23.997855+00:00"
},
"marketing_segment_id": "0d7f84b9-d87e-41ba-808d-c7bf005dc2d5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6415aa65-feda-4bf4-be93-5e91dc2b7faf",
"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": "89de41c5-b726-44c1-9734-5cbdf685814d",
"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": "beb3fc3d-f46d-4ee8-8d24-f5aa6b9ff339",
"db_country_code": "sample string 28",
"feelist_id": "cb0338da-e2df-443f-89f1-d6715319ce31",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "860723f6-8f9d-47e2-9297-b9c924f4d7ab",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cf6dc69f-6d88-4317-a995-f196ae9d4dab",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-18T21:29:23.997855+00:00",
"db_currency_id": "ab272c00-1503-4102-99d3-5be4de5d923d",
"db_currency_code": "sample string 10"
},
"company_type_id": "ffea60bc-ffc2-4144-b1c5-6e5af29c6537",
"company_type_name": "sample string 32",
"company_type": {
"id": "22a242f4-af83-4e2c-8218-9ee1acd68be8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d196aed8-6226-4b31-870a-c42ef8b551d5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "76f22e93-ddf2-4cf8-996a-274a676e639e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "362cbbf4-d78f-47e0-b3b0-baec942e6283",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "05b49068-2c60-464b-8f2e-d6750bbc21d8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8e3c27d3-8525-44f3-b8da-9c1dd7165f93",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-18T21:29:23.997855+00:00"
},
"company_sector_id": "e30f3c91-b0cd-4586-94b3-2c1d03e2e8c2",
"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": "56cd2dcc-78fd-435a-b0c3-f8785f226990",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1057d965-7519-4868-b288-4de133c5f196",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9b8cf03a-a791-477d-9839-2ee2faada588",
"account_manager_user_code": "sample string 56",
"company_status_id": "ca0acd71-5357-4053-aef7-c3e7d3e6bf10",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-18T21:29:23.997855+00:00",
"id2": 60
},
"db_language_id": "c2755ad1-ad1a-4e83-9f5b-bd721ba85d42",
"db_language_code": "sample string 7",
"db_title_id": "73dd5caf-529c-44d4-9137-4422e1c157b5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-18T21:29:23.997855+00:00",
"create_date": "2026-09-18T21:29:23.997855+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-09-18T21:29:23.997855+00:00"
},
"modified_dateutc": "2026-09-18T21:29:23.997855+00:00",
"id2": 22
}