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": "800001f8-2dae-44d3-911d-38b22202a0d7",
"_parent_id": "b00482d6-3a4e-4bb1-99d5-93f83341fac3",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "7a161f56-54fd-45a2-8982-9183ca0a4d89",
"company_id": "1a5059f2-3d9e-47b4-9999-3030740979f1",
"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": "050b6dab-f303-4437-88fb-169ca27ad439",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "5c0d5bbc-b409-487c-b354-568c2b14dd07",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "303c2845-95f3-434d-8d43-7677e7cb19e8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "57afc858-875b-498b-a244-b6eaf1e36f70",
"company_code": "sample string 5",
"company": {
"id": "1f33fcb3-fb20-4006-bb6f-c6e0cc689920",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-14T06:22:43.8373796+00:00",
"sales_territory_id": "0945f6c1-076f-4066-b577-1156d4a0e5dc",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cd68478c-7e84-468e-85b4-1e3a8c245fba",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ee7ac0ab-c3e3-43e9-9fa6-f288f2c90a10",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a1430a1c-21e8-4960-8a55-fee87f9f386a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3523d9d0-11ef-4d14-9c46-428cb399b289",
"db_currency_id": "3e491678-b9c7-4e50-b3b4-b3d1bcd20558",
"db_language_id": "16b1bc6c-4f0c-4c3f-8b7f-6b1ac42dd7f8",
"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-02-14T06:22:43.8373796+00:00"
},
"modified_dateutc": "2026-02-14T06:22:43.8373796+00:00"
},
"marketing_segment_id": "c25c6ac7-3858-4961-8c30-c1f598a9a682",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "37255359-25ee-4608-a87b-28f062e89bf9",
"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": "c88cb44b-0b40-45f1-b958-fa3e64561474",
"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": "444bc1f1-5769-40bf-adca-52dac48135d8",
"db_country_code": "sample string 28",
"feelist_id": "8553956d-5fb5-40f1-b452-b883b9f00fcb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1d4095ae-31fa-4477-a817-8fcfbd7868f6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bf28f808-9e8b-4070-9857-9b842bd0faa9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-14T06:22:43.8530039+00:00",
"db_currency_id": "1dd4d08e-8848-4fac-a043-009650debc4e",
"db_currency_code": "sample string 10"
},
"company_type_id": "530f0151-01db-45b3-8d43-dff827854462",
"company_type_name": "sample string 32",
"company_type": {
"id": "af134800-49d3-4ce2-8a3d-0b89520af4aa",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c2dd6a7c-4379-4655-b874-cc58cad80624",
"sales_organization_code": "sample string 5"
},
"db_language_id": "26bfe1fe-526c-443b-9d28-98c966a9cf29",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "746e2454-cee9-4957-af29-eee3e0911eef",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ee724943-b9c4-4360-8837-46ea96b2659d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c180ea2a-6094-472c-962a-8fc0ba162ec3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-14T06:22:43.8530039+00:00"
},
"company_sector_id": "2a260075-45b4-4d0a-a8b8-386416125b4a",
"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": "b3a054cd-1c16-45df-85fb-7536447aceb9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2e2b1d81-a685-4d6c-a6dc-1a845192d3ae",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "857d6402-cb96-4a28-ad28-694efbc1fefb",
"account_manager_user_code": "sample string 56",
"company_status_id": "68a3ca0f-5e6a-4e5b-a3e2-61d79f3ce923",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-14T06:22:43.8530039+00:00",
"id2": 60
},
"db_language_id": "6c662f85-c16f-4521-9c60-40168488ba48",
"db_language_code": "sample string 7",
"db_title_id": "c13a8e09-f881-482d-88c0-abb7922ec541",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-14T06:22:43.8530039+00:00",
"create_date": "2026-02-14T06:22:43.8530039+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-02-14T06:22:43.8530039+00:00"
},
"modified_dateutc": "2026-02-14T06:22:43.8530039+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": "10b220f6-6689-4558-af3e-2c9724444ed1",
"_parent_id": "4d12bfd4-9c51-4b83-9099-9a0a29fa37c2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "39b07bf1-0dc2-48b5-98dd-e3497af31bb2",
"company_id": "8653d97f-0ba4-4def-b607-0bc075486511",
"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": "a50c6b26-82fe-4d9a-b80c-10d7401b239a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c64040d9-5b96-40f9-829d-fe3f19d7cb21",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "eb22ad7c-2267-428d-aba6-885819931f93",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fa7f5587-68c9-4f15-b29a-30f67ea5f5ad",
"company_code": "sample string 5",
"company": {
"id": "fa628f8c-d96e-4b4c-95b8-89834a31e222",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-14T06:22:43.899885+00:00",
"sales_territory_id": "d4861e25-c6d8-41e5-8c7f-3484ec8bf6e5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f8f29a42-c1af-4eaf-b0a9-cc5b6f394568",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a52274fd-e641-4682-9fbb-8320478bbc29",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "83186f4b-2367-4501-a688-5f099479fc2d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79b98f64-8f43-434d-ae6d-30ed3782684d",
"db_currency_id": "d5907616-755b-448d-985a-a1c38bfa63dd",
"db_language_id": "df0672b3-e8c2-49ac-9201-899f86fe3333",
"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-02-14T06:22:43.899885+00:00"
},
"modified_dateutc": "2026-02-14T06:22:43.899885+00:00"
},
"marketing_segment_id": "84cc4068-f7b6-40e8-888e-9ac88bb4368a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c4949bf4-396b-4e8d-87f4-84da4f4e03f6",
"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": "a194f0ed-eac3-4e46-bec7-c7d2bcb949fe",
"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": "e97592e5-4c5e-4723-8f71-d9b0bb192c0c",
"db_country_code": "sample string 28",
"feelist_id": "b7039a83-0ed4-432b-925c-c2f4ef50d337",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a973b51b-4824-498e-bfb6-16507e99f863",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "54f504bc-3f19-4b37-85f6-96c0c229e65f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-14T06:22:43.899885+00:00",
"db_currency_id": "dd3419c0-e045-4d68-966f-3a15cd8b6f3e",
"db_currency_code": "sample string 10"
},
"company_type_id": "efe1089f-6931-447e-9510-8912e4e2ee1c",
"company_type_name": "sample string 32",
"company_type": {
"id": "08e76d77-3fcf-4f04-ac22-00be71a4553f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "35ddd0db-cba4-4d10-b62f-c28893d1a7eb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f002d6be-a3c3-4fed-9d23-fe338c869741",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "abedd631-7ead-4098-a2b4-09cc22d71508",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "aad62579-daef-4367-81d0-8e97c316b8ae",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8d904203-2f5d-4b5d-9c3e-82832b05b4b2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-14T06:22:43.899885+00:00"
},
"company_sector_id": "145397f3-f985-414f-be59-c57d7a39c3a3",
"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": "23044dd3-9f5d-4232-afe1-1f8217864721",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "834b234d-5767-4a09-b13a-b4988721013a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bbb52000-5c5e-48a7-9aa9-dba04b5612af",
"account_manager_user_code": "sample string 56",
"company_status_id": "bc89ffcb-f487-468e-adc0-dfd6fc7ec1a4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-14T06:22:43.899885+00:00",
"id2": 60
},
"db_language_id": "60121dcb-691d-4efd-8ffc-f1069eafa131",
"db_language_code": "sample string 7",
"db_title_id": "6fb7e19f-8d73-49cc-8e74-fa24dd904ef6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-14T06:22:43.899885+00:00",
"create_date": "2026-02-14T06:22:43.899885+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-02-14T06:22:43.899885+00:00"
},
"modified_dateutc": "2026-02-14T06:22:43.899885+00:00",
"id2": 22
}