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": "5a96809e-46b6-4049-9c1c-b59c12eb0775",
  "_parent_id": "bc66814f-6b29-4c61-9236-0c640cedb6a6",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "634fef18-f52f-41dc-be1a-7fff6d866f33",
  "company_id": "3b3f844e-7eb6-4dca-95ca-875156d9938c",
  "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": "9296e6ef-7da0-4840-838d-4b2dc5f3eafe",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "71df4536-8e09-496a-b842-8678a801b1cc",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "4d640cc6-d179-4080-a5a8-0c4e40c0498a",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "6c888666-f016-4826-9e95-8bcffe6fccc9",
    "company_code": "sample string 5",
    "company": {
      "id": "c4889bce-d24d-4083-a884-dceb8d720afa",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2024-10-30T03:59:07.258885+00:00",
      "sales_territory_id": "6a9239b2-500e-4f7a-9cc4-f8aa8b600155",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "369d89cd-81eb-41df-b8a5-46c83f925bcb",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "2060b528-c841-40db-ad7a-abd60a79fbca",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "097efb2a-e0ca-4aba-b1e1-4e86f950fa7f",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "29f06d95-a0f6-4c5e-a3a8-aa1cdea944a9",
          "db_currency_id": "4a4c2d3b-49f2-40ea-abc8-f0869a55ff91",
          "db_language_id": "7d66ef8f-a4e1-42b4-adc5-adf18be7948b",
          "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-10-30T03:59:07.258885+00:00"
        },
        "modified_dateutc": "2024-10-30T03:59:07.258885+00:00"
      },
      "marketing_segment_id": "35207415-c273-492c-8c5e-b5a9892396b2",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "51ac98ba-2540-4ff0-b24b-d5f330ec3c94",
      "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": "af1eaa4a-f657-45e7-991f-4a9053d1db30",
      "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": "6e30656e-bf28-4c03-ba99-ab94bc3d21ea",
      "db_country_code": "sample string 28",
      "feelist_id": "133bb74a-2098-44b3-b0a6-81e33ead1922",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "a8dede07-5e27-4552-94f4-736dca0c9a25",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "fdc813d1-1536-4f5b-81a3-b309c850c525",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2024-10-30T03:59:07.258885+00:00",
        "db_currency_id": "0bfa1e45-f25c-4f1a-b47f-72e5c3f9f69e",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "3307a9b8-2ff0-4a2e-9cec-505902cefb8f",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "8009a808-871f-4214-a22c-dba84de05703",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "17e2dc58-a62e-4d14-9bfc-4eb9d6d7d744",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "7adcfec9-dee5-4f05-9335-12752dd3116e",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "06109037-e0d9-488e-ba68-dc1bceb8dfea",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "cb5bd275-92fc-46d7-81bb-059174091c5f",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "9efb5f63-6aa7-4bec-9dfd-37e7573841a5",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2024-10-30T03:59:07.258885+00:00"
      },
      "company_sector_id": "9e3fa95a-9235-4ade-97d6-5617eb953014",
      "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": "148c61cc-1852-461d-b5f7-d4569dc1806c",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "0b04d139-caff-46ca-a8e8-f11836fd7f4c",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "7c47919b-0ab5-4628-8c30-2c7752fc0b6f",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "f08a15a1-b0a0-4178-8612-5787dd822505",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2024-10-30T03:59:07.258885+00:00",
      "id2": 60
    },
    "db_language_id": "444c54b8-3a6f-48b5-bc66-e95fefcdf4d1",
    "db_language_code": "sample string 7",
    "db_title_id": "dd7db2f3-1e1a-45bc-a9b0-bbd7a277a0e4",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2024-10-30T03:59:07.258885+00:00",
    "create_date": "2024-10-30T03:59:07.258885+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-10-30T03:59:07.258885+00:00"
  },
  "modified_dateutc": "2024-10-30T03:59:07.258885+00:00",
  "id2": 22
}