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": "d2d8ca81-3bb1-4e34-8f32-b12ec1d6279f",
"_parent_id": "b1ed8ca5-5e86-4c21-807a-94f6e259241d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "8b5bd7aa-c04c-44d5-bbaf-742879bbd615",
"company_id": "083959b3-dda5-415d-84e5-d05199731a4c",
"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": "85a4442b-0560-41a2-8481-ff4ab27af300",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "7527ce65-1008-4f1f-bfa9-c11f916ce393",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "b4e32b30-eed2-42db-8a62-727edf91a05e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bf87f97e-b43a-4736-9da8-7c68e8ab7ffd",
"company_code": "sample string 5",
"company": {
"id": "25e0665b-f6fa-4c2f-86f1-e37c4b9e4476",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-02T00:56:07.3270138+00:00",
"sales_territory_id": "cd44a1bb-a32d-4cea-99b3-d6b216b066bf",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "03d79bd8-a178-433d-b51d-ca9408885d1f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "160d8e9b-b212-4f4d-9f0a-75e94cdd2b79",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fde20fda-e333-43cc-b0cf-519f7652ebdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "926b59c3-b644-43c3-8f77-538084bc80fe",
"db_currency_id": "a7c65abd-a4a7-4468-bdfd-61e626651032",
"db_language_id": "164a1e62-09ce-4e23-bdc6-66787b683cc9",
"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": "2025-04-02T00:56:07.3270138+00:00"
},
"modified_dateutc": "2025-04-02T00:56:07.3270138+00:00"
},
"marketing_segment_id": "408c6ee2-f257-4ad1-8db9-2c65ccc07fc5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1833b182-119f-43fe-a54e-a3ada0c32c1f",
"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": "6f27031b-05a2-4112-8d43-39145f01e8ec",
"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": "b749ee06-e8aa-4f1e-9aa7-a8ca23f5fa04",
"db_country_code": "sample string 28",
"feelist_id": "fb016649-9d21-43b0-837e-c03865edb32e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f3c1f8c8-0a0e-4aa3-bf3f-71d925bb088b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3219b097-cef7-4540-be6d-f9dfa145c5cd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-02T00:56:07.3270138+00:00",
"db_currency_id": "1dda0562-a81b-40be-989e-8f0dd0844ed6",
"db_currency_code": "sample string 10"
},
"company_type_id": "26c8f4a5-7b30-46be-87e0-eaf95a95c302",
"company_type_name": "sample string 32",
"company_type": {
"id": "191cccc8-bb60-4287-8909-0f6330ff338e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bc79efa0-59f2-4d88-91fc-674698ff4ff3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a29103fd-b4d3-4e78-bb44-922c0ae1a733",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3e295fe1-b34b-41e8-85e4-b6e8b1415085",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f44dd163-ec64-4395-8309-add237084755",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2a5d8d18-7fff-40d9-9b02-8b1e539cfc09",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-02T00:56:07.3270138+00:00"
},
"company_sector_id": "53164faa-b61b-48ec-b38b-52dff2b70556",
"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": "b67af8e2-6d26-4387-ab5e-5830b7714e72",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0a7a39e8-9325-4914-abd9-d4d485fc0874",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "00e5a265-b2ea-4d91-9d9b-3f2f1b4196a2",
"account_manager_user_code": "sample string 56",
"company_status_id": "18990614-65f7-4741-97c7-e2f0b7ebabf2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-02T00:56:07.3426386+00:00",
"id2": 60
},
"db_language_id": "8da86905-7df6-4583-bfd0-d75cf07757a5",
"db_language_code": "sample string 7",
"db_title_id": "0eb8d6d1-05c2-4c82-b564-29b651182cf6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-02T00:56:07.3426386+00:00",
"create_date": "2025-04-02T00:56:07.3426386+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": "2025-04-02T00:56:07.3426386+00:00"
},
"modified_dateutc": "2025-04-02T00:56:07.3426386+00:00",
"id2": 22
}