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": "64383a91-26bb-4a6a-a5f0-2a75fd891a97",
"_parent_id": "60a1b200-33e4-478e-b890-1e689ab274f3",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "7ef548e3-3003-4fc5-9562-da15d6442c3e",
"company_id": "d0348cc1-05c6-4714-8ad6-aef3aa2b16d2",
"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": "ac8b03f4-a9d6-4e74-ab4a-abf76f91229f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "606180be-ce7f-476e-a656-77cba9f79391",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "25990cd9-c616-4f7e-84a6-3fd35fb5466f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4dfc0eaf-ba7b-446e-93d3-5632722410f8",
"company_code": "sample string 5",
"company": {
"id": "fe9904ce-9ab0-44e6-828f-bd3855bfb850",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-19T05:03:08.9152268+00:00",
"sales_territory_id": "11ce130b-32c1-4bb4-abd7-026c4edd4b24",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bd3faa6f-1cd2-415f-afcf-64a0a5fcada4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8d9b9d2e-5ade-4272-93b1-7da05af4d93c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c27dced6-8fb9-4e03-a978-0dce1d1b39df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfe11b6c-6f14-47bb-854e-04b707d1621a",
"db_currency_id": "58a7ea17-61a1-4a6a-bd94-afcbbfc8f66a",
"db_language_id": "9b0ba4cc-74b6-4cf9-ac33-a2fe9fdc2df5",
"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-08-19T05:03:08.9152268+00:00"
},
"modified_dateutc": "2026-08-19T05:03:08.9152268+00:00"
},
"marketing_segment_id": "29b8d89a-a8bb-4965-a9da-a44f2f8eaaae",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "598d1b2c-b49f-4cee-b26b-5dfcf1bfe226",
"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": "5ae2cb7d-2047-4cc9-989b-37c51968c617",
"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": "515112f4-fbdd-4073-ab7d-523ecd4ed2e9",
"db_country_code": "sample string 28",
"feelist_id": "7f9a055c-ef7c-487b-be2f-5dacb61b5ecc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ccbc7b8a-0e24-4c5d-ad00-b8f1f379b4b2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7851ff3d-40dc-40da-9216-8c797860e773",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-19T05:03:08.9152268+00:00",
"db_currency_id": "935150c7-9957-43bd-ab4f-68779ae30934",
"db_currency_code": "sample string 10"
},
"company_type_id": "52c7de98-ddd3-46cd-97f0-8901602d2dbb",
"company_type_name": "sample string 32",
"company_type": {
"id": "49b7b6da-3167-4335-aa98-b25fb84cd6f2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5a05e0c4-e018-45ee-827c-14cf12e5876a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7f40cdb6-dba9-4fcc-97e5-96da198f2ff9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "45cdd56c-375c-4374-8051-01ef56478154",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9574f0b7-f0c3-4309-9632-c865066329b1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d1a7408f-c084-4414-8f28-37c1df4796e0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-19T05:03:08.9152268+00:00"
},
"company_sector_id": "aa864ab0-95bf-44ec-a058-ef0061635654",
"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": "f0f0da27-368f-4b2c-b03b-1df4b75cc854",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b54b7a37-b8c0-47c6-833c-17e47cc4a7f3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1d27698f-481a-4b91-94ba-5779c07a4b5b",
"account_manager_user_code": "sample string 56",
"company_status_id": "d25e956f-78e4-4119-9ee9-75f773c5019a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-19T05:03:08.9152268+00:00",
"id2": 60
},
"db_language_id": "b9e0fc39-8dc9-4ccd-b3b3-98b3e9ed3006",
"db_language_code": "sample string 7",
"db_title_id": "d4f4f631-d9a2-4951-b496-622226713d91",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-19T05:03:08.9152268+00:00",
"create_date": "2026-08-19T05:03:08.9152268+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-08-19T05:03:08.9308465+00:00"
},
"modified_dateutc": "2026-08-19T05:03:08.9308465+00:00",
"id2": 22
}