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": "1506c39c-ae77-4187-bf94-1a6a4b656c12",
  "_parent_id": "45b78221-573e-4f68-b920-876617896ea9",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "7a7adaa2-845e-4271-863c-955b5dc76145",
  "company_id": "6b07a3b2-8ed7-437f-859c-41a6766c95de",
  "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": "2febf1c6-a368-49ad-90ee-527fc895cb53",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "fdaf6968-06b8-4128-b291-c0288a362444",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "ef590de4-80e1-4f13-9749-15bca604d66f",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "8a53243a-4c6f-450d-a4b9-845cbfa41aaa",
    "company_code": "sample string 5",
    "company": {
      "id": "77aa0079-f31e-47be-9b8a-19a13b3350fa",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2026-11-16T16:50:35.6303546+00:00",
      "sales_territory_id": "f7101db4-2840-45e3-bf14-3595b45ef6d4",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "f681ea57-b826-45d5-970d-a081f52b637b",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "41b53138-6db0-4021-9fd6-f0efdc350dbf",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "2510ee61-d270-49d2-b154-f2c2582844a4",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "2d8ce8a6-b718-461d-b1ce-71784c5c7770",
          "db_currency_id": "5886523a-867b-46a0-a91b-f3b023a4b13c",
          "db_language_id": "3e488c3a-f0e9-4b70-8d8c-5ba249b787d6",
          "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-16T16:50:35.6303546+00:00"
        },
        "modified_dateutc": "2026-11-16T16:50:35.6303546+00:00"
      },
      "marketing_segment_id": "5fc2a22f-4b43-4802-9c96-6eec0c962f1f",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "912c3a56-2843-460a-9e92-0b9e0e2b1afd",
      "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": "3f39199c-f773-4bf2-8343-a2c4bedf10fb",
      "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": "661cce5b-3e6b-4ceb-bf5b-68e279334576",
      "db_country_code": "sample string 28",
      "feelist_id": "d6b9bb97-7434-4562-ab1b-b03507d764c0",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "412ae566-f6b3-4390-86d9-ea292d3c9345",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "0371a602-a7e3-4f89-9fbc-8859b6b227e4",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2026-11-16T16:50:35.6303546+00:00",
        "db_currency_id": "19174a95-69cc-4e5d-921b-4a095436beea",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "0a4b76c6-3398-4a31-9f74-4404e3a9b9a3",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "f8cf8c0a-87cc-4cba-8c93-085eada64d41",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "825911ae-5e82-4bdc-a093-1efe7c09097c",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "5579c7a6-7cd1-427e-9662-c5ff720234cd",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "4a221fc7-531c-447f-860a-bfb8b0575c8a",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "0f21b20d-20c4-4a53-aa30-b26bd918f8d7",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "a176cbe7-7fe7-455a-948f-2767a2ccf382",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2026-11-16T16:50:35.6419137+00:00"
      },
      "company_sector_id": "f2caf602-2f35-49fb-846a-445b3b66331f",
      "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": "7dbd6eab-ed00-452c-b309-27e12e937f22",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "2672f535-f744-40e7-8d3a-d5949c992825",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "fc98e79b-ad10-4323-b70f-fe8780c3c9aa",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "eb6eba4d-aba6-49d0-9b57-86300c392e73",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2026-11-16T16:50:35.6419137+00:00",
      "id2": 60
    },
    "db_language_id": "2cbed1c7-ee42-482f-88b1-bbd8c6ebcfbd",
    "db_language_code": "sample string 7",
    "db_title_id": "e26c97bc-6a61-41f1-b0ca-46c8797e13e2",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2026-11-16T16:50:35.6419137+00:00",
    "create_date": "2026-11-16T16:50:35.6419137+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-16T16:50:35.6419137+00:00"
  },
  "modified_dateutc": "2026-11-16T16:50:35.6419137+00:00",
  "id2": 22
}