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": "a5fac3c0-1ff3-4794-920a-e44c230f7a3c",
"_parent_id": "ffe3e845-1370-43e3-9d8b-ace3028c5cc3",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9b06cca2-b857-41bb-a60e-6f67add8ed58",
"company_id": "c3935aba-4a83-488e-a91f-e95d67293ab7",
"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": "e3f1ebd8-61c3-42cf-a4de-c47357f35667",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f9e03864-f18c-42d9-9de6-b2bc1b4f012a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "68acd392-3242-4158-af98-0f7743646b92",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ecc91add-57bf-442a-84c2-440c22575914",
"company_code": "sample string 5",
"company": {
"id": "0f4ff441-56ba-48b2-be31-9a7983a5ae35",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-18T06:04:58.0372934+00:00",
"sales_territory_id": "d89d3738-d27f-474d-9145-33a1dc23a4cc",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f3510fcf-f087-4134-88bb-98dd25564b09",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d4858401-c592-49cb-9f7f-87ee195233ab",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "055735f0-5f56-4e80-b0f1-54e3f5b21da8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a54d9078-d98a-4c8c-b5af-01885aa242bc",
"db_currency_id": "88fae6ae-367f-44e2-a0fa-9a66bf3ec4f3",
"db_language_id": "3b73e14b-2d81-48c9-b487-2f81385eee53",
"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-18T06:04:58.0372934+00:00"
},
"modified_dateutc": "2026-01-18T06:04:58.0372934+00:00"
},
"marketing_segment_id": "60046302-4bb9-44a0-b089-0a0a23850cca",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f5606fe9-98d7-4fe4-a456-c0622286233a",
"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": "be03472c-8147-409a-aef3-abd07ac2e261",
"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": "5ef74358-a3b2-46f8-8a42-6646e19c3e64",
"db_country_code": "sample string 28",
"feelist_id": "1254569f-efd4-4d13-9c42-b83c8cb863da",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "29571ffc-b711-4d9a-bf8f-beabd1444a4a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9af8b830-0e08-4620-bf9f-f5522731e739",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-18T06:04:58.0372934+00:00",
"db_currency_id": "6f51094e-406c-4837-a055-6859f827ff27",
"db_currency_code": "sample string 10"
},
"company_type_id": "e3537e2f-2612-44d9-973d-5cac38804a1c",
"company_type_name": "sample string 32",
"company_type": {
"id": "0a408243-f5fe-4959-8b92-5a5e81b0704d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "67b97cc7-1231-4631-8236-d4da5aa7bda2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9f873be8-5ae1-49da-8d72-25cdd4c25981",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "55f6137d-0edd-403f-bc4a-c028f8cca239",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "29f81672-71b5-4d2b-878d-507f5f219d8c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5149aee0-e5dc-4256-bc3e-67352fd79b24",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-18T06:04:58.0372934+00:00"
},
"company_sector_id": "fac18a55-1ed5-4a52-b3f5-6f45d3126a34",
"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": "96f39120-e9e5-4e59-a937-9f61edcdd5a3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2d353707-e6a1-4297-9308-ad2548dee5ae",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cd629e08-d044-40d0-9a5e-999e9a468cea",
"account_manager_user_code": "sample string 56",
"company_status_id": "f404b3bc-715e-4a15-a1c4-b9a72aeaa046",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-18T06:04:58.0372934+00:00",
"id2": 60
},
"db_language_id": "719576a1-63f4-41cc-b7bc-f5fd706e8aff",
"db_language_code": "sample string 7",
"db_title_id": "f836ca47-8ec5-4fc0-b128-19f47e0b1306",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-18T06:04:58.0372934+00:00",
"create_date": "2026-01-18T06:04:58.0372934+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-18T06:04:58.0372934+00:00"
},
"modified_dateutc": "2026-01-18T06:04:58.0372934+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": "11eeb9a5-1fe3-4204-93dd-31f0570ba94e",
"_parent_id": "0fef77d7-fe45-426e-bd28-81c2c1dd85e7",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "0663a7ff-f708-4e4f-b1da-7682ff9d52c4",
"company_id": "e27b8957-28df-4e2a-b9f9-951a07ef4f2f",
"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": "12278904-e52f-495a-8bdb-b6fac098d0d3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "2f0f7fcd-be1f-4556-8c46-6fabf69b23a6",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "58f743d4-62fa-4f0f-9c74-0b1e74e01be2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ece4f9fb-21ae-48b6-b8b1-51c4467a515b",
"company_code": "sample string 5",
"company": {
"id": "d6303b0c-608b-46aa-8f6e-1bd8ee87e8f4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-18T06:04:58.0998127+00:00",
"sales_territory_id": "ec97c8d2-4ac2-42c7-a7e7-462595ddcf9d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e1dd3ce5-2e9e-4d41-bd09-07060297da3a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "54dcc7df-6ed7-4e68-9696-63e0ba5ddf35",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c186e600-8daf-450e-bb7e-708ab7eb4661",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0113c32d-d995-4b87-99b4-a01af7c44bfd",
"db_currency_id": "1d448481-1dcb-4033-ad6f-9e4dfe14f0bf",
"db_language_id": "02cead1d-b529-4919-a16a-e1cd3c3c7468",
"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-18T06:04:58.0998127+00:00"
},
"modified_dateutc": "2026-01-18T06:04:58.0998127+00:00"
},
"marketing_segment_id": "a9245c8c-fe21-4cb0-ba85-4472012b85dc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2997d9e2-a6a3-48a8-b75c-a74e67f1bd2d",
"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": "bdfd0630-3721-43d0-8c41-0f2f2cfabb56",
"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": "0e87087e-57c3-4ab4-a2fd-93d8cdffdf56",
"db_country_code": "sample string 28",
"feelist_id": "89c374c8-3777-44da-96bc-b3741c9fed16",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ced78380-481d-4ad2-91fc-e13b53065adf",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c5c27a64-5953-40d5-982a-626ecc14b164",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-18T06:04:58.0998127+00:00",
"db_currency_id": "fe555ef2-428e-4b36-a721-7731a8dcae01",
"db_currency_code": "sample string 10"
},
"company_type_id": "1a7aa6b6-afc5-4a83-9fb6-0059f928fad8",
"company_type_name": "sample string 32",
"company_type": {
"id": "0cc4b602-29fd-416e-b36e-25a35a472178",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "680c0d40-802d-4483-89f8-2e9359118282",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5ab83c00-dac0-4546-a144-e8555c56c0e8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2ba5b4b8-2606-4697-bed7-83086540fb68",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3356fba1-844f-400e-b7c4-a85b45d890ca",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1996e1c3-ee41-4588-b996-58ff8b147b5f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-18T06:04:58.0998127+00:00"
},
"company_sector_id": "7722eeb9-d607-47c2-afbb-566e658a0871",
"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": "7717a960-46ef-49d1-b32e-78924fd64a7a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b32d08fc-f882-45e7-b208-49fee8759c82",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cf7323cc-2f07-4c28-9dac-feb6e8d3cdfc",
"account_manager_user_code": "sample string 56",
"company_status_id": "65196fa1-0305-4adf-9181-5f9618032242",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-18T06:04:58.0998127+00:00",
"id2": 60
},
"db_language_id": "b04285e1-0b4b-42d7-b5bf-6dc918ab31cf",
"db_language_code": "sample string 7",
"db_title_id": "70a5f4e4-0ca5-495c-8dd3-4e35ef602e8a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-18T06:04:58.0998127+00:00",
"create_date": "2026-01-18T06:04:58.0998127+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-18T06:04:58.0998127+00:00"
},
"modified_dateutc": "2026-01-18T06:04:58.0998127+00:00",
"id2": 22
}