Creates a new location object

Request Information

URI Parameters :

None.

Body Parameters :

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

Request Formats :

application/json, text/json

Sample:
{
  "id": "1d57a0fa-07ae-4172-91eb-c4abe36e162b",
  "_parent_id": "31f0c355-c619-4ad3-a856-bfde4c9f2718",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "9f1f97ee-f7e7-4e12-891d-d99be0557e54",
  "company_id": "45fb127f-323c-4dde-b19c-afcf6e1fea12",
  "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": "1729dd01-9b4a-4409-8141-b32288d31827",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "841ca015-9a28-4f7c-9901-ca368994172a",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "53071028-8ee0-428d-9516-f89a3e3fab6f",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "4ac65688-b28a-4e09-a192-16be99192e78",
    "company_code": "sample string 5",
    "company": {
      "id": "435f02f6-cd0a-4a93-9507-f28d4681e770",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2022-08-17T04:10:53.1853981+02:00",
      "sales_territory_id": "70ec1db6-30b4-41ea-bf90-90d2a5119abf",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "05af00cd-7457-4aeb-8e22-8ca2ef84db71",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "e5436234-7cd8-4c6d-a51b-108890f0632c",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "1bff2500-74eb-45cb-84a1-3b27dd34973b",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "a3ea6fb5-53d0-4109-a579-e000c41551ca",
          "db_currency_id": "6b10576a-76e2-4dd2-82a7-fb9c7241da58",
          "db_language_id": "bcd38164-13d3-44ce-90f1-c05476649f90",
          "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-17T04:10:53.1853981+02:00"
        },
        "modified_dateutc": "2022-08-17T04:10:53.1853981+02:00"
      },
      "marketing_segment_id": "5bbec238-e5e3-4c6d-99b4-0595c42857d5",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "af97b5d2-b9e5-44e7-963c-0891c3f0a9f8",
      "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": "a7a8ba1b-8f6d-4922-a74a-1a8c3b8bd5ba",
      "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": "f88259d3-d6a5-4488-afd7-0be6b72444b7",
      "db_country_code": "sample string 28",
      "feelist_id": "85882a93-b6a3-4811-831b-4035618ad882",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "9b93d808-d0ad-4eda-aca7-f29ccbe47d48",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "6795e05e-155b-4472-bbb7-505084d10c57",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2022-08-17T04:10:53.1853981+02:00"
      },
      "company_type_id": "2178974d-72a3-40f2-ac1b-dd810210f480",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "70e60065-eebc-4bcc-b200-fa93efa39f89",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "eeb2ba6d-d6e1-4d2d-b591-02a2b097ec07",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "a84f0f3e-67ab-45a0-a7ea-c2653a4fc223",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "c3fcbfcf-91a3-4c93-a31b-414711eb75fd",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "71ecade3-7437-4c17-9502-aad9a00b2a3d",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "14d0de01-e043-4a3a-a85b-f9a34a90c36b",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2022-08-17T04:10:53.1853981+02:00"
      },
      "company_sector_id": "17e9f438-50ee-42ca-8936-737d2b296485",
      "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": "c17d97f1-9397-4b4d-95f7-2d012adb4e86",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "dbcece34-f024-434a-acd9-d032b5d71e3f",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "02b07e98-7d10-4fb0-8876-cde146d7ed80",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "5e4d6096-84ce-418f-8ed5-32caf37842ab",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2022-08-17T04:10:53.1853981+02:00",
      "id2": 60
    },
    "db_language_id": "49935a06-95ee-4d19-ba5b-d5745f8b789b",
    "db_language_code": "sample string 7",
    "db_title_id": "41fd11eb-64b0-4acb-ac0d-ce452af76247",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2022-08-17T04:10:53.1853981+02:00",
    "create_date": "2022-08-17T04:10:53.1853981+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-17T04:10:53.1853981+02:00"
  },
  "modified_dateutc": "2022-08-17T04:10:53.1853981+02:00",
  "id2": 22
}

Response Information

Resource Description :

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": "c6758c58-2fee-4238-9a31-aac2cf2bf637",
  "_parent_id": "235439f2-6ce2-4d2b-9db1-ab8c030fd959",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "9f92c2a4-7aa7-43c0-8912-64bd7de679a7",
  "company_id": "12bd86d8-f729-4e96-b524-506bca617e07",
  "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": "afbb01f3-7f7f-496b-ae0f-f0071508f372",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "a5010bb3-7647-47ea-b24f-5bc6abc53fbd",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "5a74d46b-8fce-4e8d-8968-a52901019ea5",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "546ce27b-15cd-468c-b54b-40095d5847d6",
    "company_code": "sample string 5",
    "company": {
      "id": "d7aa71c4-f302-49db-9e73-121c24a3facf",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2022-08-17T04:10:53.1853981+02:00",
      "sales_territory_id": "925638ad-d06a-47da-8e71-43872b9c6d1d",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "4f1f9fe5-c4ed-4a40-8fa3-c6a4ba6d37c7",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "88bf531c-9482-4c7e-b961-059be9a08c9f",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "b8fda03f-90af-4383-98e4-f096f8f29a22",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "71589d27-fabd-4c51-86f5-025f1ea57d62",
          "db_currency_id": "778c96c9-3c23-41bb-9d46-97031d609fc7",
          "db_language_id": "bd36a17f-512f-4c93-9716-1a3f84a704de",
          "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-17T04:10:53.1853981+02:00"
        },
        "modified_dateutc": "2022-08-17T04:10:53.1853981+02:00"
      },
      "marketing_segment_id": "85e475fe-3b7a-45f7-9328-5c3b74f0e91e",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "8eb32361-df65-4940-9c28-7f472d373865",
      "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": "cda5f0e8-110e-47ed-b97a-c326e0093368",
      "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": "fa0a68a1-7282-4ef7-88fb-5733eb8494f7",
      "db_country_code": "sample string 28",
      "feelist_id": "e8e55106-f17d-4156-9a26-20a72c74b1a5",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "99b8b4dd-3342-45a0-9172-c83b35d4ec66",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "8bb2a731-15f9-41ab-a9c9-a56df7a8dd1c",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2022-08-17T04:10:53.1853981+02:00"
      },
      "company_type_id": "58c82db4-aa50-4881-bd75-3d1444e163d9",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "37d46795-66e1-4e3b-84b7-fb9905115be0",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "dc7537f0-6906-4f79-9795-6401342eb231",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "eb102d5c-9a9b-4b98-8de0-a9b9eb5316e1",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "1405e5c2-a7ee-4457-aab2-7a10d0e14c61",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "3ca099d6-4bb8-42d0-952c-615d8ab49d01",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "2297d356-7746-4648-b682-87bd79242de9",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2022-08-17T04:10:53.1853981+02:00"
      },
      "company_sector_id": "44c7a10f-5422-4a2c-9a87-2f11a87815d9",
      "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": "c47a091f-a1ff-4ce7-8c2a-66b99e048b51",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "c0a2fd56-a870-41c3-a1d1-a6a4ea14b180",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "f986eb15-f945-4e0d-a5f4-23938fb7e801",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "d016a583-4354-4d2b-af7e-631e33ddae55",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2022-08-17T04:10:53.1853981+02:00",
      "id2": 60
    },
    "db_language_id": "52bca027-278b-4469-86cb-dc1d392686dd",
    "db_language_code": "sample string 7",
    "db_title_id": "d025adb1-c8e1-4ed3-9974-ea87466b3f19",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2022-08-17T04:10:53.1853981+02:00",
    "create_date": "2022-08-17T04:10:53.1853981+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-17T04:10:53.1853981+02:00"
  },
  "modified_dateutc": "2022-08-17T04:10:53.1853981+02:00",
  "id2": 22
}