Retrieves all the locations

Request Information

URI Parameters :

None.

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": "aa25d539-4053-45e4-8c12-796ab3dc808a",
  "_parent_id": "26efdf29-b24e-46f3-bac1-c9daff21e70d",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "c947a798-00d5-433b-b5d1-ae5780bc4dbc",
  "company_id": "6cd006b8-78b3-41a7-8431-e288390aff9d",
  "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": "073141b4-108a-432f-b323-b7b85b278909",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "eae1cfdb-0a98-4ed9-9e68-4a4b87f85e84",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "5202b5f9-f3c1-4720-9224-a97737b1d226",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "c002df30-eaec-4e0c-ae33-848a6d84a24c",
    "company_code": "sample string 5",
    "company": {
      "id": "84ec3947-b25c-4daf-8cef-f092eb151783",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2022-08-17T02:42:04.7983645+02:00",
      "sales_territory_id": "2a84ba98-85a7-450b-bac0-da96646826e3",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "c703f49e-f6fa-4475-96f5-203a7c7d6358",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "13242158-8e8d-4fe7-be93-ace0b29cd118",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "784f61df-67dd-41cf-9d2e-f1ddddbca6e1",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "c66cd8d8-824f-44eb-af4d-37c4fc0e7e39",
          "db_currency_id": "5dad17c1-e15d-4b25-a79d-956a4f3660a1",
          "db_language_id": "a3c162d6-979c-46a1-b50c-3fd74a2fcd14",
          "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": "2022-08-17T02:42:04.7983645+02:00"
        },
        "modified_dateutc": "2022-08-17T02:42:04.7983645+02:00"
      },
      "marketing_segment_id": "b0f295f4-b2b3-4eef-bfb4-e33999e2f3c4",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "76488acb-0ecf-4cee-9816-ff4ced7cc835",
      "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": "8a0b8b31-ee30-4365-8ae8-8f6b21a7e767",
      "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": "08546b68-62af-47a2-8b8c-2f4a73a53999",
      "db_country_code": "sample string 28",
      "feelist_id": "8792cdfa-83cd-42d8-9a8e-0f10c1d2fc56",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "4fdf62f7-0b95-48eb-9041-68b5606953e7",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "f1a677ca-fdb8-4ffe-8a15-75b8e98ce8a7",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2022-08-17T02:42:04.7983645+02:00"
      },
      "company_type_id": "4b34ecd3-a399-4759-af87-ff63293063bb",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "6a67cccf-b011-4f05-9d25-1091a9ed034b",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "c6d25be2-4c99-44b2-9cf2-d88bff90de52",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "94766cea-5a4c-4a60-9721-114c73ca3d26",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "37d65496-1091-42b5-8dd2-9b0554a1c82f",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "9af24933-a621-4643-a6b6-f7700915e989",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "3b309a25-150d-4263-a9c1-1a1ab81bf5eb",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2022-08-17T02:42:04.8184813+02:00"
      },
      "company_sector_id": "d10a7960-681b-4be1-a5d8-7ad972ecb171",
      "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": "f17f52f5-3640-42d3-861d-00e75791b3cc",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "74d9bedd-a9ac-4caa-82e2-2b181eee2f60",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "60a70658-f5b3-4855-8b0d-053d77e0fd1b",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "74e8e663-c302-42e7-94b3-d1e1c85a4b34",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2022-08-17T02:42:04.8184813+02:00",
      "id2": 60
    },
    "db_language_id": "53cecf89-1db8-4f21-8f81-aab0fc483e9e",
    "db_language_code": "sample string 7",
    "db_title_id": "63543bc4-20ae-41d6-8c68-ab8ed298c3ea",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2022-08-17T02:42:04.8184813+02:00",
    "create_date": "2022-08-17T02:42:04.8184813+02: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": "2022-08-17T02:42:04.8184813+02:00"
  },
  "modified_dateutc": "2022-08-17T02:42:04.8184813+02:00",
  "id2": 22
}