Creates a new location object
Request Information
URI Parameters :
None.
Body Parameters :
location| Name | Description | Type | Additional 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 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": "102ef82e-7300-42f9-b6b1-2452a6afeafd",
"_parent_id": "0493c9a9-7b60-436d-86c1-97156473254d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ff55cb56-631b-45b5-9e69-f10389410de7",
"company_id": "2a184817-fcb1-455d-bf44-eaa7a8523551",
"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": "7979d279-14d7-45af-81cf-888ee7951182",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "aab16e15-8aab-4cc7-a549-bc5894b4d75a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "10e3cb0c-4d43-4138-ad48-b05f44516d73",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "eff5dd4c-6002-4bc3-8704-2f246aebc3f0",
"company_code": "sample string 5",
"company": {
"id": "ca090b59-9c58-4358-94a3-6e507a582719",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-24T04:22:21.5375817+00:00",
"sales_territory_id": "139431a3-3f45-4069-9a7e-0a1d8fdea199",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "18550893-0911-4945-b7a8-dad1921105c0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dcd114b7-99ae-44f5-88b4-d1e70d002655",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8b8117ab-387b-4673-b833-a37773667e48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0eb5440-55d0-40c4-915a-3e946aaabaed",
"db_currency_id": "807f32e5-8dad-4b07-bcc1-9138a38cedfa",
"db_language_id": "9fc5a462-39ec-4535-8ce1-feaab635a383",
"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-05-24T04:22:21.5375817+00:00"
},
"modified_dateutc": "2026-05-24T04:22:21.5375817+00:00"
},
"marketing_segment_id": "44a7b5a3-a4fc-467a-8842-ddcfd0ef5938",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e81352d9-b141-4779-a88f-e64cfebdce80",
"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": "c7dcaf00-014a-4e89-838b-0cbb4b165a4b",
"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": "a4645685-70aa-4a98-8ca8-3f5d49623f04",
"db_country_code": "sample string 28",
"feelist_id": "cd0f3cb0-d0e4-4b2d-ba9b-ad1d982dcc1a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "12c4f622-7a67-498d-abc5-7f9fc6064338",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "29061ff3-6d06-497f-9b75-7c54e3ee63ad",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-24T04:22:21.5375817+00:00",
"db_currency_id": "a99d7dc3-5867-4390-bc7b-a9a1529b7493",
"db_currency_code": "sample string 10"
},
"company_type_id": "73ac405e-f5a6-4c0b-92fb-d1a30da40f68",
"company_type_name": "sample string 32",
"company_type": {
"id": "05b9bebc-2674-4b19-a928-4cd48db21f85",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ef24c2c6-9f8d-4469-942a-b6f3ede0df91",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bea32298-ee29-42d8-8847-6a4720fa96f6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5b7332a7-ef05-442c-a024-c225d3aa0cf3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8bcf28ca-2be3-4544-883c-054f7acf35f0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "17da39ff-3120-43bc-af91-6d63d3f481e6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-24T04:22:21.5375817+00:00"
},
"company_sector_id": "e1e4e741-df97-4cf9-85c4-fc857018afbd",
"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": "ee07b496-8311-43ee-a5db-7091bc856eb0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7658ea9c-5bcc-4288-8ff0-d91033651657",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b00bf6f5-4557-4390-a230-a5b56a84ca01",
"account_manager_user_code": "sample string 56",
"company_status_id": "f5aa77a8-18cb-40ee-a322-c9df22d3a737",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-24T04:22:21.5375817+00:00",
"id2": 60
},
"db_language_id": "d8f5f2bc-bc1f-4262-bba3-e000c129cfd5",
"db_language_code": "sample string 7",
"db_title_id": "f1a7504d-05b5-4166-97aa-80a7a78224d0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-24T04:22:21.5375817+00:00",
"create_date": "2026-05-24T04:22:21.5375817+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-05-24T04:22:21.5375817+00:00"
},
"modified_dateutc": "2026-05-24T04:22:21.5375817+00:00",
"id2": 22
}
Response Information
Resource Description :
location| Name | Description | Type | Additional 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 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": "8c2ff5bc-c383-4891-82c6-a4471b214fda",
"_parent_id": "20da567c-8acd-4661-a725-99cdb3b62c2a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "56a17f19-397f-4a96-b5ea-027c691b25e6",
"company_id": "255de888-2972-4843-aca5-464799f227df",
"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": "38e78d93-2e5e-47cb-8d0c-9aff436493a7",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "bcff0dc6-fd72-4a90-bb27-298cc73ef6ab",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6cf2b120-12d6-4a76-b366-2a87f5a09597",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2609fcdb-d63e-4831-91b7-7e9b34954f9c",
"company_code": "sample string 5",
"company": {
"id": "b9d93bbd-518c-496c-a727-6174899590f3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-24T04:22:21.5375817+00:00",
"sales_territory_id": "2395ea40-6c75-4cd4-8cf3-a58f1276dd6c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5a223850-d0df-48e1-b38c-19f704395b6c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "04da89a8-9cec-40aa-8738-cb905a865f48",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "025557e0-4e10-4735-ae97-fa88a59d2ab7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a69cf23-843d-4f3b-8b31-423c7b214e5d",
"db_currency_id": "52f4f3fa-dc4b-44f7-a414-8c1321e176d4",
"db_language_id": "8cc972b5-8310-4a65-9a87-98c2fd1dfc79",
"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-05-24T04:22:21.5375817+00:00"
},
"modified_dateutc": "2026-05-24T04:22:21.5375817+00:00"
},
"marketing_segment_id": "413ada2e-b032-4148-b8ae-4c4a912518eb",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ba452a00-03b8-4147-a90e-ba65e21c2bcd",
"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": "41af0d36-d6e0-4cfb-99dc-145a126caf1b",
"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": "1f8d2911-a94c-4833-9839-bc5a858636fc",
"db_country_code": "sample string 28",
"feelist_id": "3b08690a-c624-4b15-a998-ce6d00092d6d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2468850a-3c60-4eda-a414-c8c1499c749b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a1066a56-020e-43bf-9802-604ee16cc348",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-24T04:22:21.5375817+00:00",
"db_currency_id": "63ced2d3-c3a7-4771-ba7a-ef684ab3b0dd",
"db_currency_code": "sample string 10"
},
"company_type_id": "0acbf1c0-c966-430f-98bd-0b64b05e6862",
"company_type_name": "sample string 32",
"company_type": {
"id": "73889ed8-18a8-4326-9f46-09e2b4c8f57f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a1256dae-da20-448f-80eb-72dec46a5d05",
"sales_organization_code": "sample string 5"
},
"db_language_id": "658d46f7-05ad-4f6b-89c5-a6faa5f176d7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6492b287-e26a-4b8e-8ca0-54df9f055b52",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "518e49f0-8b4f-4f5c-a07d-ccc7610203e6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "194a4b39-1cfa-4cac-ab94-e644aa7f27d4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-24T04:22:21.5375817+00:00"
},
"company_sector_id": "aa7442e0-b260-4cb3-a426-97c471bf336b",
"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": "612815c4-f4f8-4fab-978a-601b0dd45e40",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e0b2bcbd-fad5-4cad-a57a-aa5f186fcfee",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0c4f4584-600f-4139-9df0-153092cb59ad",
"account_manager_user_code": "sample string 56",
"company_status_id": "d3d90712-595d-455b-bf26-c6a298920b19",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-24T04:22:21.5375817+00:00",
"id2": 60
},
"db_language_id": "5df1dcd2-1806-4c9c-92b7-bcfc90568c98",
"db_language_code": "sample string 7",
"db_title_id": "32901782-acff-460f-a8b4-f38f3c7a6751",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-24T04:22:21.5375817+00:00",
"create_date": "2026-05-24T04:22:21.5375817+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-05-24T04:22:21.5375817+00:00"
},
"modified_dateutc": "2026-05-24T04:22:21.5375817+00:00",
"id2": 22
}