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": "97f86ff8-ae46-441f-b9b0-33b5ffe59b51",
  "_parent_id": "e158233c-7400-4c97-90b1-c1fbbc25693d",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "14cbda73-eda6-491c-8979-a1a5115bdfdd",
  "company_id": "ad00874c-99cc-4159-90c8-010859f347a5",
  "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": "7532c718-ad6d-4ff8-baef-0c8d55e5dc7d",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "5d9f98ef-56f3-4a19-bda9-edc383aaf13d",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "92cc04c9-5ac3-4441-920c-cd253bf64bd3",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "4cb00b6f-0a1e-48f3-b03b-6624999eafef",
    "company_code": "sample string 5",
    "company": {
      "id": "51556bf1-8b5b-4652-9fcf-bbfe241db210",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2022-12-06T04:38:23.3430961+01:00",
      "sales_territory_id": "ad35141a-86ae-409b-9b50-3ac339d2caa8",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "e8052948-8663-496b-b20c-4f8f4c95a08d",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "fce1e070-dd75-47d9-81e4-d02be635e05e",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "667ce643-5615-40f7-865c-40cd8278b16b",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "48e1903d-5418-486d-bd22-1c5b547cb98f",
          "db_currency_id": "9a0acbce-ffc7-400f-ab70-aae245e49427",
          "db_language_id": "50825226-967f-4c40-bb1b-59b3655581b1",
          "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-12-06T04:38:23.3430961+01:00"
        },
        "modified_dateutc": "2022-12-06T04:38:23.3430961+01:00"
      },
      "marketing_segment_id": "3785f705-c443-4d04-8b84-2e6a717b2fc3",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "55dcb16d-f133-4f31-85b9-69a4cf015927",
      "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": "7a8610ea-ec4b-46e9-b25d-19cede639c03",
      "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": "67855bda-6199-4717-8073-2abeaf99a131",
      "db_country_code": "sample string 28",
      "feelist_id": "1094edb4-bec0-4294-b54e-2724f88d04cd",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "6febebc2-8e4b-49c4-9c8b-2f52a7336a93",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "29d83345-93cc-451d-b537-dbeadcfece19",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2022-12-06T04:38:23.3430961+01:00"
      },
      "company_type_id": "75988c9c-531e-4c3d-94c2-0c9386f50faa",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "5e7a250b-2e63-4d90-bc6c-4b957b1300ce",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "ffefb53f-5387-48c8-9972-c1a063975173",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "cd198214-26ab-4f1e-87b0-2da24ed0aea1",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "dec62b67-9b7b-49d0-87f7-0811d51520da",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "daad5c07-933e-4ecc-920b-1de702b062ed",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "7f431458-5b98-49a1-96c9-352ccc99f020",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2022-12-06T04:38:23.3430961+01:00"
      },
      "company_sector_id": "c7501b08-b43e-41d3-9b80-bfeb113697f1",
      "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": "f6649c5f-0488-428d-85e2-4c35f95d9db6",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "cd4153b0-53d8-461d-a561-331da3d0d816",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "ea8ac2ee-b561-4dd8-a4ce-a6a9cd48d6f0",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "a7e289df-da41-4ea5-adf8-91ed0af9d901",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2022-12-06T04:38:23.3430961+01:00",
      "id2": 60
    },
    "db_language_id": "4fd76b0c-c134-487d-9d46-0561a3e580a7",
    "db_language_code": "sample string 7",
    "db_title_id": "34b3cb47-1085-4bc6-857f-3b476e469589",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2022-12-06T04:38:23.3430961+01:00",
    "create_date": "2022-12-06T04:38:23.3430961+01: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-12-06T04:38:23.3430961+01:00"
  },
  "modified_dateutc": "2022-12-06T04:38:23.3430961+01:00",
  "id2": 22
}