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": "52bc6994-7254-4bee-a8d7-4165038fa6c8",
"_parent_id": "cc77582a-315d-4534-a228-235612b3d531",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b4f5b133-0952-4a09-a073-00e841a37c14",
"company_id": "b99ff34b-acd6-4978-a39a-75dca19ac72c",
"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": "12cc2f9e-195f-479a-a9dc-e5d05a474d5a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "4fe38716-b111-4f50-bc5b-d0b45d01273a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f2dedb36-0654-4539-b19e-a6ebee09e724",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e8e85273-d3a8-4f91-84fc-a80447070568",
"company_code": "sample string 5",
"company": {
"id": "10a9671f-a8a1-4709-9d79-fa4879433a14",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-22T17:39:05.8792893+00:00",
"sales_territory_id": "d9deed90-2f67-418c-b764-dbea257f2138",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a22194ad-a97b-482f-b699-21c03a5c5883",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "529f49b9-d845-47d5-b93c-443767692961",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "396d704a-cc82-45b6-bdbe-401246ba85a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c99fe3b-40c3-4144-b589-2a5674fefe9b",
"db_currency_id": "b2fdd7dc-2b57-4473-9ab8-0228f457b666",
"db_language_id": "54d7ceca-6758-4884-845a-d4bb17860547",
"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-02-22T17:39:05.8792893+00:00"
},
"modified_dateutc": "2025-02-22T17:39:05.8792893+00:00"
},
"marketing_segment_id": "712364fe-9895-467a-900c-fdb36e562f6d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2be15123-ee5a-43b5-bfc9-78563c612d31",
"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": "8c739165-0762-41bc-8cda-a2a47b52f898",
"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": "c281cd4a-d1fd-4bd7-9b51-aef488db0852",
"db_country_code": "sample string 28",
"feelist_id": "24a16cd1-8d30-4fba-b0c6-25a1321a91f8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9b5adbe1-cbf6-499d-94c5-001dffdd9f21",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ce6d462f-badd-4c55-b478-a42426e83c24",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-22T17:39:05.8792893+00:00",
"db_currency_id": "524059a1-88af-44ee-b8e5-071fa4ae7c71",
"db_currency_code": "sample string 10"
},
"company_type_id": "36ba3c42-73ea-4d91-80c8-60475793e1e4",
"company_type_name": "sample string 32",
"company_type": {
"id": "76a446f2-431b-4c29-9542-a1ec9f3e6bf5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d3d21629-6d52-4959-ad48-101d9674cade",
"sales_organization_code": "sample string 5"
},
"db_language_id": "639ae1b7-cd66-4cee-b92e-657de72a51f4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5c2ee234-a4da-4020-adac-b2751245eafd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ecb9dcf0-d9c3-4207-90e3-1a62402a456e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "659f4778-2ac1-4717-bab2-04356bcef552",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-22T17:39:05.8792893+00:00"
},
"company_sector_id": "3f245ff4-1eb8-4a65-9bd4-886a6e5ac325",
"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": "9f00f759-78f3-4f17-bb1f-6e631871bdee",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "14fbb30f-e85c-4d50-95b0-e5f2f4fe62cd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6f5d1da8-e682-47e7-bc2d-207a877d25f6",
"account_manager_user_code": "sample string 56",
"company_status_id": "0bc64ddb-1246-4f34-88bf-606c7dd031f9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-22T17:39:05.8792893+00:00",
"id2": 60
},
"db_language_id": "77420c14-3211-4458-b29f-cda6272ccba2",
"db_language_code": "sample string 7",
"db_title_id": "3d97e956-61e3-494d-981b-6edd8460ab93",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-02-22T17:39:05.8792893+00:00",
"create_date": "2025-02-22T17:39:05.8792893+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-02-22T17:39:05.8792893+00:00"
},
"modified_dateutc": "2025-02-22T17:39:05.8792893+00:00",
"id2": 22
}