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": "29909beb-da49-4f95-b4d4-bcf061da482b",
  "_parent_id": "0d96e8a4-02a0-4aa5-8519-be7bbd2a704a",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "4500110a-0773-4f70-9dca-066c4cb0d74e",
  "company_id": "7675b5cf-e77c-429a-a0d6-9bd7dfc0d1cb",
  "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": "74b0a20a-99d2-483e-bdc6-082b510d0639",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "bac9e534-5ed8-422e-9cd5-325fbf07b03f",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "b5aaf764-e7f8-4b90-949e-3cf08f353500",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "1072c836-d69a-4b41-80cd-cc7ea93cd59b",
    "company_code": "sample string 5",
    "company": {
      "id": "c04d4902-6463-4a55-94c2-b44899778a0a",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2026-11-19T17:29:37.1552278+00:00",
      "sales_territory_id": "ae596b9e-4fb0-4470-bfaa-db3bef3ad2ee",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "e35d4d16-a55b-4700-8679-53ccb4aabd2b",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "15cae17c-088c-406b-8818-6bb469607db6",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "d53d0320-a0f9-4308-8bd7-225ce2a8a252",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "2f28db4f-b23d-4946-889a-c33af8682c05",
          "db_currency_id": "a5afa5e2-73fa-4106-a6cc-d30ef9b03dec",
          "db_language_id": "ec5238d1-6f79-4924-a2dc-53239c2c9534",
          "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": "2026-11-19T17:29:37.1552278+00:00"
        },
        "modified_dateutc": "2026-11-19T17:29:37.1552278+00:00"
      },
      "marketing_segment_id": "bb3f9b5b-4624-44f5-ab74-102b53b47bf6",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "4d57e4b9-5c94-4c4b-a5c4-c5d3a5e31dde",
      "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": "b69cdf38-89d8-4fca-bcb8-3b4e81aea60f",
      "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": "168c231d-9aad-40b8-94f6-3611c0d34cf2",
      "db_country_code": "sample string 28",
      "feelist_id": "6cd033fc-04e5-403a-95c9-2595eac8ea08",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "d2b56b63-709a-4d94-be7d-8e73855ff541",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "a5303a18-837d-42f4-ba89-31da2bd3f1c8",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2026-11-19T17:29:37.1552278+00:00",
        "db_currency_id": "a6d22636-759f-43d1-aa08-5bd2b9b4f124",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "67b46e71-bc63-4dcf-a139-dc9605c66141",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "02efe481-32ef-4663-9dc0-a8a25a225800",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "94c9da23-cf79-4db1-a601-bdcb5fc7fafb",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "72d8f7fb-46d1-41b7-8bdd-dd6c2c1bb49e",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "2c9e28e3-88de-4f82-9214-d14bf901410c",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "93a56af3-d4d0-4de5-96aa-54ebdf181983",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "35490437-a1d3-49e8-afcb-ae5d9949a962",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2026-11-19T17:29:37.1737078+00:00"
      },
      "company_sector_id": "52754164-8eb1-4359-aab9-7b46726b4cdf",
      "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": "32292247-937b-42e5-a70c-9e265d01ef63",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "572e8177-c83a-4dd9-9eef-3435f2ba4c5e",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "b0e22d65-c17f-4d4c-b34b-26a97e09b473",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "2ca272ef-c7b1-43bc-a21b-f87ac606a0bf",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2026-11-19T17:29:37.1737078+00:00",
      "id2": 60
    },
    "db_language_id": "8d4804e1-75be-4c79-b9a3-42e3d990f4dc",
    "db_language_code": "sample string 7",
    "db_title_id": "1e27e007-122e-4b87-b537-f398b144c868",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2026-11-19T17:29:37.1737078+00:00",
    "create_date": "2026-11-19T17:29:37.1737078+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": "2026-11-19T17:29:37.1737078+00:00"
  },
  "modified_dateutc": "2026-11-19T17:29:37.1737078+00:00",
  "id2": 22
}