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": "559ec729-ba2e-4ddf-8afd-34bbcb1e0871",
  "_parent_id": "fc50be34-2609-4491-bc2b-ac64f3a076e7",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "564badb4-b725-4eca-b06c-3aa8e1ca9f63",
  "company_id": "8bfc163f-7934-475b-85cc-4a32256ce2a7",
  "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": "2f75f216-d6ce-45ea-a8bf-d3afccf0fded",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "a0db6aca-1359-48b1-8c32-23bfcec9bbd0",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "bec6cc7b-8d42-4be7-82ab-f55bfbe04e10",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "db49889c-534a-4031-8826-02d9c06518dc",
    "company_code": "sample string 5",
    "company": {
      "id": "b977ce15-c99c-4a83-9e48-cf5bb0e0aceb",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2025-10-17T02:46:05.4352638+00:00",
      "sales_territory_id": "f3d1d37f-c99a-444e-b274-aa04211c4dac",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "1a6b3d0b-f619-48f4-9f51-169651557f79",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "5d6c7b30-efc1-4e4e-b6bc-61dabf83c937",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "41e183e0-9ec8-4374-8128-d0221b2bfad3",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "9133980b-fb99-44b0-bc20-ab229e3c93be",
          "db_currency_id": "583a497a-1bf4-4cf3-b6bb-d512a4bfef50",
          "db_language_id": "6f0a1411-d327-4ace-9423-72408bd18e52",
          "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": "2025-10-17T02:46:05.4352638+00:00"
        },
        "modified_dateutc": "2025-10-17T02:46:05.4352638+00:00"
      },
      "marketing_segment_id": "bb7d63f9-5674-4750-9b17-4828b620b781",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "1c9fbb5c-d832-41c1-b4db-16036f26ccfa",
      "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": "bd1bfecc-6884-4b23-aff2-e73adb502b18",
      "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": "232c8c2f-ad5d-49ea-b129-e492f885ab33",
      "db_country_code": "sample string 28",
      "feelist_id": "7564a869-5528-4b77-8b7c-ee1ae2b7d40d",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "4541a7a6-4f7b-4bf4-a04f-2a9cc631aa73",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "f16c9d60-c0b7-47db-9e77-097e022ef508",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2025-10-17T02:46:05.4352638+00:00",
        "db_currency_id": "a9688b83-4292-4f12-8bb1-ae18f47e18f9",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "46fdde71-6aa1-499b-b182-a38c9d957254",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "1b54caea-97e9-45ea-a507-c2d948b0247f",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "9e29beee-0a2c-4871-9e0d-8bdce31c696d",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "14f8e3b0-619e-46d3-84eb-b164496c4f83",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "5ec18d31-bda6-4980-9f52-948467ea3b73",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "74a52d19-1bd8-4f2c-b9e3-8fc0cccb895a",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "ff44ca95-efba-47dd-b3a5-499f2b6503b4",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2025-10-17T02:46:05.4352638+00:00"
      },
      "company_sector_id": "31169b18-f05e-4d94-8627-55876075e1f6",
      "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": "7c9fc725-68d3-48df-89b2-16ff998624f6",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "3fe32cb3-4391-4de4-b62b-7dd9ba54ff64",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "b0e2e609-c3c6-494d-9ae3-24573af7a430",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "872a567d-7495-46b4-ba43-c94df1553596",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2025-10-17T02:46:05.4352638+00:00",
      "id2": 60
    },
    "db_language_id": "35dc2e7a-0327-4b4d-b952-2233c00429cf",
    "db_language_code": "sample string 7",
    "db_title_id": "9b3b8597-10b5-4c53-87ba-fae6135f1784",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2025-10-17T02:46:05.4352638+00:00",
    "create_date": "2025-10-17T02:46:05.4352638+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": "2025-10-17T02:46:05.4352638+00:00"
  },
  "modified_dateutc": "2025-10-17T02:46:05.4352638+00: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": "d64a4d00-1e56-40fc-b5df-d10725814857",
  "_parent_id": "6ca98959-656d-4da3-8e49-0946ed4bb294",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "19d5cd97-bc6e-4795-96d1-8f2be257751e",
  "company_id": "c875ab85-9764-4e58-bdee-4729959337fc",
  "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": "6f15989b-2cfb-4421-9384-86cc2efc38da",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "03933042-998f-477d-8059-457f3e056a82",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "06d71576-ab95-45fb-b8c5-95fbc08d8751",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "58a8df7a-42d8-4283-a25f-67a0183a9bf0",
    "company_code": "sample string 5",
    "company": {
      "id": "a34d56c9-7b63-42aa-8455-bc58e52ca5a8",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2025-10-17T02:46:05.4352638+00:00",
      "sales_territory_id": "70c7abb3-a664-4661-b354-30ee4b82bec8",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "2db0205d-7c2b-421b-9156-55c5c93f40be",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "3da52845-882d-47fc-b8cb-484d140b385a",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "16656719-461b-4123-ac84-f45779cbe39c",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "bcbcb0a8-f881-4504-97fb-33c9ad8d8aec",
          "db_currency_id": "f171c8c1-3f76-45dc-bb88-524c307fe262",
          "db_language_id": "3d1b9283-1021-4796-aaab-dea9ae7fc490",
          "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": "2025-10-17T02:46:05.4352638+00:00"
        },
        "modified_dateutc": "2025-10-17T02:46:05.4352638+00:00"
      },
      "marketing_segment_id": "787d0107-f532-4169-9f40-577352f1414b",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "5e2ad695-4bf9-4704-be65-3e83754aea19",
      "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": "4e5e3945-6221-4b7a-9053-7e6c47093212",
      "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": "17ce1325-6aff-4976-bb66-1adadb47d394",
      "db_country_code": "sample string 28",
      "feelist_id": "866b056a-93c8-4d61-9292-954b41e9caf5",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "835e50e6-9f25-41d1-b51c-de62ad3b8596",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "fa39de06-9ad2-47f2-aee3-fd2e7a59178a",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2025-10-17T02:46:05.4352638+00:00",
        "db_currency_id": "ae97eafc-57de-4bc4-b510-2d376b3c5f99",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "4a51c7a2-cac8-4b26-85d4-2b0816be1d5e",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "5d579b51-294c-4ee6-ba53-4fa354ba6967",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "dffce5a7-61b1-425b-994c-b0da1a195202",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "6e842033-41d5-4b44-8608-5b57854e2ec4",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "9494d59a-8f28-444c-bfae-80a0bbc7ce14",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "f33eb8f3-1717-453d-b81d-d09028a78235",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "aceb4fe4-609e-48cd-953a-d9fab4a0f376",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2025-10-17T02:46:05.4352638+00:00"
      },
      "company_sector_id": "b0b23ab2-c477-44f7-baa8-45b2b952290a",
      "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": "1abda97e-3ad0-4fd7-85f4-54e6735c203a",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "e329735e-0616-4557-9552-fdd822d65135",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "890a9166-4918-41cc-9d90-2e3acc6a0d4a",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "adbb05b7-31fe-4fa0-9121-6e7f9106e04b",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2025-10-17T02:46:05.4352638+00:00",
      "id2": 60
    },
    "db_language_id": "1e67b5a9-0182-4bac-878c-8b70ea74760c",
    "db_language_code": "sample string 7",
    "db_title_id": "6157d6c8-5de3-43d4-9493-232a1557f2ff",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2025-10-17T02:46:05.4352638+00:00",
    "create_date": "2025-10-17T02:46:05.4352638+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": "2025-10-17T02:46:05.4352638+00:00"
  },
  "modified_dateutc": "2025-10-17T02:46:05.4352638+00:00",
  "id2": 22
}