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": "2cbb4426-d4fb-49aa-9da7-c8bcc6452f77",
"_parent_id": "a29662ff-f1b0-4601-be2a-f6c3f741cffe",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "10608eee-ede8-4e89-a548-3a0e6513598b",
"company_id": "2e5b641b-0277-4a65-b802-6807bbb3ceef",
"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": "81b1f861-b92d-44b0-ac9c-ccce259e93d1",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "179c44db-4f50-4d2a-a181-fab3b7701984",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4854fd5b-26d6-4fd9-87bf-d9f666044d38",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "62fff9f9-0cf7-4748-b2a0-5e301cbb250a",
"company_code": "sample string 5",
"company": {
"id": "67ea9ae6-76a8-4714-a388-8f3cf5e86bf1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-24T07:52:25.8098682+00:00",
"sales_territory_id": "f0ce2749-f65a-4b46-bc56-387455b9ad54",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "03fec566-5d2b-4870-ad77-3ff8e249eb08",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "38ea1cc2-d62b-446d-9649-2101422b4832",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aa56caa1-61b4-4e90-bc28-a88fbafdbf73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6bc4c1af-b25b-411a-9a35-106899c215e6",
"db_currency_id": "69fda84f-8803-4edb-b3a0-543101677e37",
"db_language_id": "ae0fda71-4516-4f18-a0f0-dab2e7d95cfb",
"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-01-24T07:52:25.8098682+00:00"
},
"modified_dateutc": "2026-01-24T07:52:25.8098682+00:00"
},
"marketing_segment_id": "96324598-e29d-4821-83ab-05ecc620f79b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c0c4eacd-82f6-43b6-98aa-57a630516c28",
"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": "82e3bb5c-68f7-4d48-a7b6-7dd20bfa2dd5",
"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": "5cedaa27-c6da-445d-a45e-348752a3eaa3",
"db_country_code": "sample string 28",
"feelist_id": "0879840e-62a0-4c2d-890c-ffcd8e235b15",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5a5d2cfd-f9c6-4f1a-8816-335fc6540ab8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "181e30fa-27ac-4ceb-8b8d-69d75a23ab01",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-24T07:52:25.8098682+00:00",
"db_currency_id": "cc3ea1a4-3bb7-4551-9425-0b4b01471a6e",
"db_currency_code": "sample string 10"
},
"company_type_id": "e8f27312-6a9a-4c2f-a62d-b35d4ccc7668",
"company_type_name": "sample string 32",
"company_type": {
"id": "d3a3ee57-df50-4496-a2f0-01feabb19706",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d7df1e5f-b990-4a43-bab7-b6ff503595b3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3699b603-be02-4f1a-88f1-0ca4521503db",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "78e41f9f-81a0-4ddb-bf68-fe2dc0d8a37f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f371f889-5136-47ee-9220-8be2569e3c37",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9b70176b-d47d-46af-9f62-570894b1b187",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-24T07:52:25.8098682+00:00"
},
"company_sector_id": "8e930d2c-1d9b-450e-94c3-64736196a4dd",
"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": "7a32e384-bc64-4d76-955c-547d12dd0a2e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9b0c91ce-6cf0-4f17-8a16-77851870da91",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a380204e-1f37-449b-b3d5-cda7a8e93889",
"account_manager_user_code": "sample string 56",
"company_status_id": "97dcbddc-6131-4587-9459-e78baf31962e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-24T07:52:25.8098682+00:00",
"id2": 60
},
"db_language_id": "e8f9cf97-5f3e-4dce-9cde-2347f68573c8",
"db_language_code": "sample string 7",
"db_title_id": "17e766a6-756c-4fcd-bd77-cab804d67a75",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-24T07:52:25.8098682+00:00",
"create_date": "2026-01-24T07:52:25.8098682+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-01-24T07:52:25.8098682+00:00"
},
"modified_dateutc": "2026-01-24T07:52:25.8254935+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": "121c6d31-a411-43ec-b100-a8ac4caa663f",
"_parent_id": "8439aa36-3781-4424-a38a-1ad285118d1f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "0029f2e5-d939-4761-a4b2-fa88896c3ea8",
"company_id": "68d5fd96-a3db-467d-b53b-25add7d7080b",
"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": "6482c49b-bd0d-464c-b371-fa664f25759f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f30df34c-bb80-466c-bc51-10f3d71dc903",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "5e30021d-ff35-4b04-b83e-10b164166c81",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2b4fd55d-585e-4e85-a8b6-5ddea827fa11",
"company_code": "sample string 5",
"company": {
"id": "a270dcca-6579-40ca-b15e-f35816e9741f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-24T07:52:25.8723686+00:00",
"sales_territory_id": "96ecc20f-6140-4c40-b3b1-ddb00110c88b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "27b7e2c8-9126-40c5-877f-872f1765baf8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "22266c72-7ff8-44d5-b58f-e33380adf3c2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b9afeb9a-7cc8-4c7d-b266-6faeda1753a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "80bac670-3e8f-4ca7-b82f-b26b07ed7be1",
"db_currency_id": "67c9c0a9-e557-4991-883a-1be08b2a140d",
"db_language_id": "c7e39fe2-9771-4b7e-b726-982bc042e463",
"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-01-24T07:52:25.8723686+00:00"
},
"modified_dateutc": "2026-01-24T07:52:25.8723686+00:00"
},
"marketing_segment_id": "b79790ef-62ca-476b-995d-be8c2af4e930",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8d942d85-2067-4353-8126-449359498f66",
"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": "26f78f66-ada4-4341-8da6-4ec1c1b9c1ce",
"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": "3b36fc38-3acc-4d8f-97eb-ced85c3e431d",
"db_country_code": "sample string 28",
"feelist_id": "4ccf24d8-4e07-45da-aa1a-60aabab6ba8d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3951c250-23b5-4ee9-b65c-a4449ff200b7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "34375568-2b57-4b71-b49f-79e298a40f29",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-24T07:52:25.8723686+00:00",
"db_currency_id": "61c5d795-5776-41a2-b1d6-21e104e42f57",
"db_currency_code": "sample string 10"
},
"company_type_id": "f73d8d09-ce16-4951-a0e4-be78988142ff",
"company_type_name": "sample string 32",
"company_type": {
"id": "705f5259-9431-4ef4-adbb-11716e32827b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5d450aff-9dff-4085-98a5-07e0111bd708",
"sales_organization_code": "sample string 5"
},
"db_language_id": "188e20e9-d0ee-4338-b301-5cd85582b918",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d7184279-52c2-4a97-a33a-96466de83d0c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b76d6fec-c587-4a05-b6d9-966b77ab2454",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d2f0374a-edb4-45ec-bfea-fc52c7e4f791",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-24T07:52:25.8723686+00:00"
},
"company_sector_id": "acad2b7e-782a-45ea-ba24-c3724ace4516",
"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": "b0c1cec7-9211-4dda-89ec-b722e616bddd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f5254744-e49d-4abb-a5d0-5279115c67e3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e628fe4c-b00c-4b5e-bbec-1ae6f47e5c91",
"account_manager_user_code": "sample string 56",
"company_status_id": "578ab064-63ca-41a2-aeee-f1fafd84c4c5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-24T07:52:25.8723686+00:00",
"id2": 60
},
"db_language_id": "693ea96d-f340-4a1c-917f-5708526fccab",
"db_language_code": "sample string 7",
"db_title_id": "1f6870f9-5f5a-4ca8-9886-de76735d6e2b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-24T07:52:25.8723686+00:00",
"create_date": "2026-01-24T07:52:25.8723686+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-01-24T07:52:25.8723686+00:00"
},
"modified_dateutc": "2026-01-24T07:52:25.8723686+00:00",
"id2": 22
}