Retrieves an object of the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

location
NameDescriptionTypeAdditional 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

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": "953d6c62-6941-47e3-986e-61639d8bf57b",
  "_parent_id": "be232a4d-bb89-48af-b8bd-de5fee3f1f6d",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "c5e3ffb7-5cec-41fa-9a41-3b6e7985b985",
  "company_id": "e028e9e6-b4d5-410d-b50f-8cd88a3d3d4c",
  "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": "81be2264-7610-4877-970d-2a215ca67d19",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "a7288dd3-45eb-498f-b633-c45099c6420a",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "372b1786-9235-430d-938b-a714ca7ae153",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "819fea31-4494-4dc0-a520-74d7a2e8fa5b",
    "company_code": "sample string 5",
    "company": {
      "id": "f0050310-9938-4b74-a03e-3a1185929a60",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2024-06-15T17:09:45.3847147+00:00",
      "sales_territory_id": "6f7092b7-c369-45f5-9490-775c1e603b9e",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "68a7b0d6-d6d0-48b6-853c-8944ec10b368",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "0d51670e-44e8-406c-936f-8ff4137b5870",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "5ca8c5b9-b85c-488a-85c2-b89e47eb4943",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "ab54ee76-8376-4472-9fe0-b8f83c3b5195",
          "db_currency_id": "45d64986-ae4c-4e40-a8cb-a26a0855fc9c",
          "db_language_id": "562519ab-1e0d-4e0a-af83-36804fb873c1",
          "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": "2024-06-15T17:09:45.3847147+00:00"
        },
        "modified_dateutc": "2024-06-15T17:09:45.3847147+00:00"
      },
      "marketing_segment_id": "72c92a6f-ce81-4099-8d57-5f0b12aa876e",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "ca732522-75f5-4234-a4dc-e3767d7863b8",
      "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": "56f0efd4-4bf2-4f26-b92f-d9f116c24d00",
      "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": "e3bc5d40-1aa3-4ab4-9d78-8cabcca32160",
      "db_country_code": "sample string 28",
      "feelist_id": "cedf76a9-decd-4390-bb62-af644097b2cb",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "97563875-1c58-4da2-8efc-0758a60a50b3",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "6f6972b4-fd68-42c9-98aa-14d45b9207fe",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2024-06-15T17:09:45.3847147+00:00",
        "db_currency_id": "076eafcc-f97d-4287-8c74-027565b187cd",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "cf87ba5c-4091-46de-bdba-e5fd50fc3c4d",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "66afd392-7dd9-4d98-adb1-3795ddde5f52",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "717396e9-7c8b-4896-b15a-f83cb664104c",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "f895a299-d2bd-42c2-a429-f631e6cdc054",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "577cbf60-7b3d-40f3-849a-256e8a72b0c7",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "70e5ca94-4cce-45ab-ba34-561cd2d4faf2",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "8ddf2f1e-36c1-43ea-a4c8-2782c666c8e7",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2024-06-15T17:09:45.3847147+00:00"
      },
      "company_sector_id": "9c890b92-a0e0-46f4-8682-71cf359e646f",
      "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": "82f29472-2a09-47fa-b153-93498d902a48",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "4448a80d-48da-4541-a15c-2e6b2ecba71b",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "da9659a1-5842-465f-a427-b21703a04f91",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "ff1f1ed6-23bb-4cf5-82a4-93178b716b49",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2024-06-15T17:09:45.3847147+00:00",
      "id2": 60
    },
    "db_language_id": "8bae6d3d-8fa9-41b4-9d33-7e625772c7f7",
    "db_language_code": "sample string 7",
    "db_title_id": "a3e412f1-5095-4e19-a502-be4f08fa20fa",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2024-06-15T17:09:45.3847147+00:00",
    "create_date": "2024-06-15T17:09:45.3847147+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": "2024-06-15T17:09:45.3847147+00:00"
  },
  "modified_dateutc": "2024-06-15T17:09:45.3847147+00:00",
  "id2": 22
}