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": "9d9855d7-24d5-4e0b-99c3-c25ba8b71d73",
  "_parent_id": "192467d8-7477-48d6-a6d7-e916e1b5f2d0",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "a3b487d9-a60f-42c4-aa53-4a0e325ce24e",
  "company_id": "abc9b85f-3399-44fb-8163-b73811c0af8e",
  "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": "91338540-99b0-457a-aa82-47bc2f4c3700",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "486e479e-d2fd-4462-b7cb-6be4ca4647a2",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "31dbc4fc-3343-407c-b472-b77cb800e4c6",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "b5d710cb-024d-44fd-b7eb-508a693901fe",
    "company_code": "sample string 5",
    "company": {
      "id": "6faf27f3-f152-4c72-b64b-b0df111296d6",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2024-03-27T08:38:50.0384286+00:00",
      "sales_territory_id": "d2ae5226-eb64-4ec3-8632-48f41ff12e1f",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "7e869144-4cc8-4e9c-a2f1-a1d9095c4a99",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "fe8dc026-b71c-4fd4-aa06-40af46dd571a",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "2dffa784-ee9a-47a8-bf88-30c57754b677",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "ccae8b21-c952-49e4-a1d1-75bdb69c6f47",
          "db_currency_id": "93772f8e-2e5f-4682-b6d9-b4b218b0c554",
          "db_language_id": "9e01951c-49dc-47cf-b0b9-90469ac01d48",
          "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-03-27T08:38:50.0384286+00:00"
        },
        "modified_dateutc": "2024-03-27T08:38:50.0384286+00:00"
      },
      "marketing_segment_id": "e1461f58-f020-4017-a40f-e05094cd8563",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "19324a4d-7038-4650-a5c3-3ef542dc5103",
      "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": "e73baa09-3fcc-4f90-9f1b-796442ed182d",
      "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": "6523117a-9e1b-45da-9951-cfdc4569cb54",
      "db_country_code": "sample string 28",
      "feelist_id": "19c37786-2edc-4711-9276-cc8a71cf3e90",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "2f9593d1-2150-4380-b058-6ea159ea59b8",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "c98a1088-101b-427d-bc45-41b023d7ab3a",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2024-03-27T08:38:50.0384286+00:00",
        "db_currency_id": "892c31d7-5232-4224-a436-30ce5861c1be",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "ee385ee0-6f37-40ce-97b8-90a558c3360d",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "e781d846-464f-4c0b-a6c5-a94a062b56cc",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "963de32c-6501-4e59-9cdc-c2b8d94d3749",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "a5523924-ffd3-4114-80a8-5d3fc8766562",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "618e615d-9cf7-487b-8472-dc073fcea9bc",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "1d7a6ac1-d4e4-4c3f-b1aa-787c195b5134",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "6b8c843f-213c-4b84-b29f-e2db2b73bf57",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2024-03-27T08:38:50.0384286+00:00"
      },
      "company_sector_id": "327c4cdc-dac3-4d07-89a6-a3520e438efb",
      "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": "37e3ecd3-92c1-448a-b114-0d8f3f3adefd",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "4b22dc3d-b687-46fc-b43e-c8d140a48ead",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "94cb7610-d0d6-440a-8ad5-b1e4a8b96cfd",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "b096020b-667f-4a52-b890-7e2c730a746f",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2024-03-27T08:38:50.0384286+00:00",
      "id2": 60
    },
    "db_language_id": "8559b373-b172-4851-9a14-dcd2b6ebff4b",
    "db_language_code": "sample string 7",
    "db_title_id": "1d873ad9-3d49-480c-bdf4-43ca5bfb5a3f",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2024-03-27T08:38:50.0384286+00:00",
    "create_date": "2024-03-27T08:38:50.0384286+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-03-27T08:38:50.0384286+00:00"
  },
  "modified_dateutc": "2024-03-27T08:38:50.0384286+00:00",
  "id2": 22
}