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": "296396a9-cea5-4473-af23-6e26b1dec731",
"_parent_id": "dcb53877-6297-4fca-83ca-c7da0bfc2a1e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "7d06021d-e2d9-4407-9497-35f982ca8902",
"company_id": "51c21c1b-6339-4c69-b33b-8bd71f14be8b",
"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": "f8a6a3bb-bcfa-400f-85ca-b21797ccd3a8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0fc0aa77-898c-44bb-8c83-83eef5d0cace",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f76bc10e-868c-428b-b57c-ff8cb942d117",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6fc918fa-8d82-4ee0-b88c-28e681226a32",
"company_code": "sample string 5",
"company": {
"id": "415d4dd1-1887-4186-abee-14b48dfe3db2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-01T07:41:55.4431168+00:00",
"sales_territory_id": "36219725-d060-4470-9f56-f778bdc56a79",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "beeecda5-7abd-43e7-b89f-60f58d6dd1cf",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3dd6964a-4ff6-4c2f-b636-03edb14c0beb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "684dfc14-75ec-440c-ba14-5f11eb9580cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7daad55-3a6b-4af1-94e6-fc4cd32b08e3",
"db_currency_id": "65503976-421e-443b-aac3-ae180115788e",
"db_language_id": "933dfe69-ad0c-4956-a9e1-2d17006aa857",
"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-01T07:41:55.4431168+00:00"
},
"modified_dateutc": "2025-10-01T07:41:55.4431168+00:00"
},
"marketing_segment_id": "c24cd92b-9fc3-417b-8ba6-967608c70a13",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3647d1b0-0081-498e-ac9b-7ce1c9e053b5",
"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": "ca4bc8ef-6761-45ee-a3b9-0edd52ea0987",
"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": "a8cd2df9-8b83-4e51-a665-87bb255decae",
"db_country_code": "sample string 28",
"feelist_id": "30907bc4-d1b8-4a0c-8d28-222ff7eedbf3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2664496d-ee28-4517-bef0-b86d8040a189",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cda8a219-6621-465d-b2dc-337d55cf9271",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-01T07:41:55.4431168+00:00",
"db_currency_id": "f51559f5-ce9b-4f39-a19d-9b7afdbb020e",
"db_currency_code": "sample string 10"
},
"company_type_id": "2077f9b6-ecb4-4558-9c6b-6b54186016a1",
"company_type_name": "sample string 32",
"company_type": {
"id": "838f6712-43b4-4e14-a524-5eb4bfd51e5b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "11399bf7-8720-437b-b6e1-72f78196ce88",
"sales_organization_code": "sample string 5"
},
"db_language_id": "97b8e7f4-5c47-42a7-9d6e-69c73a15fa72",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2c4bdacb-d6a9-40e8-9ae9-6652e98192f3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6e482225-ced7-4352-8766-accf49dc90bd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "345ce854-3f02-40b6-b93c-4ac8c6de0352",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-01T07:41:55.4431168+00:00"
},
"company_sector_id": "8ccc838a-7c39-44b1-bdfc-3f0834dcecbe",
"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": "8bcf046e-a8de-41e1-9651-4a9ea27de2e8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6314b73e-93d5-4219-be28-fe0b6c1dd34d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "229c74da-9249-4365-9d82-253b1f617372",
"account_manager_user_code": "sample string 56",
"company_status_id": "37351f4d-74d7-4cc1-91dc-2c463ad5758e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-01T07:41:55.4431168+00:00",
"id2": 60
},
"db_language_id": "827a33b1-6ca6-4617-bdd9-a1ab0e32a420",
"db_language_code": "sample string 7",
"db_title_id": "11b74c2b-a22c-436f-84e0-de16d7075790",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-01T07:41:55.4431168+00:00",
"create_date": "2025-10-01T07:41:55.4431168+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-01T07:41:55.4431168+00:00"
},
"modified_dateutc": "2025-10-01T07:41:55.4431168+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": "d98bfe4d-f029-4ad0-b882-cad094757ac2",
"_parent_id": "585101d6-a6e0-4274-956e-326d9c706ce7",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c7746357-b6fd-4614-85d6-041daa813ec9",
"company_id": "ee4ff429-39b7-479d-9cb4-361bcf1f211f",
"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": "8c95d410-ddb5-4514-85be-86c1737da867",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e23d532a-8f7b-485f-87af-1cf988cd7c12",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9c7f9fb3-4cd2-4a0c-a68a-6329100bda32",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "30c6d1e7-3e23-4f92-8535-c4b4903fb606",
"company_code": "sample string 5",
"company": {
"id": "af514cae-ed39-4b97-8b9e-ffda8f628e57",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-01T07:41:55.4743694+00:00",
"sales_territory_id": "1f210af3-c4ab-4281-855c-f16859e47fd3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5cab43dd-9d8b-4309-b2c0-ccc08cc8e092",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "28a72b44-b14d-443a-9d16-adf3772353f2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b8a6ed90-86b5-4818-80dc-313bca67e46f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b3fec4ed-278f-47b4-b1b6-2182ffdbcb38",
"db_currency_id": "35e5406e-bd51-4fd1-9b40-f98ac922031b",
"db_language_id": "eee45529-6c60-4b59-8b29-ac52467455d2",
"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-01T07:41:55.4743694+00:00"
},
"modified_dateutc": "2025-10-01T07:41:55.4743694+00:00"
},
"marketing_segment_id": "7af24d1c-4ad1-4fb4-9c04-619bc0c757e6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6b3f2e76-f65a-4053-8a25-cd58c8b4a82c",
"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": "d6c69193-649d-44bf-9994-ab84dbb34ae8",
"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": "8daf92c8-5d45-4da9-b917-215604f67a61",
"db_country_code": "sample string 28",
"feelist_id": "d88340fc-b680-452f-9682-929a7efa0b96",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "be36e705-c892-40da-8a27-e369c24089ce",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e0dcbcb0-e59d-4d35-b51b-7f7a7dd32115",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-01T07:41:55.4743694+00:00",
"db_currency_id": "a1672976-8d78-48db-925c-686f8648b3ea",
"db_currency_code": "sample string 10"
},
"company_type_id": "ad560a65-0f12-47e7-9bd8-f365dc0dddde",
"company_type_name": "sample string 32",
"company_type": {
"id": "2c59d382-1b51-4cb0-b0ac-b681e9ba69c4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fac493ae-f642-4709-8f87-07248ea45818",
"sales_organization_code": "sample string 5"
},
"db_language_id": "01ee4628-3bf2-429e-9fdb-97a6084551f2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "367043e0-040a-417d-9781-5cc7aabdb49c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "392839e9-597c-4cd3-ad35-6bf2c9a85ae1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "67c4a4e2-c2f7-4e36-9499-901ca4572969",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-01T07:41:55.4743694+00:00"
},
"company_sector_id": "2b64f837-ad70-4c80-b782-f32b29b35553",
"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": "24741883-6d76-481e-8214-01f91c16f6d0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c36dae72-7131-49df-92ae-94d408893458",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1845244c-dade-49e7-9239-7cd2620684bc",
"account_manager_user_code": "sample string 56",
"company_status_id": "69b45b9e-8f66-443e-95e8-87a27b7fd609",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-01T07:41:55.4743694+00:00",
"id2": 60
},
"db_language_id": "17be3bfb-5157-4621-8393-1a6a9f23583a",
"db_language_code": "sample string 7",
"db_title_id": "dcaed1b7-a0c6-4763-9e0f-b9e3364fce07",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-01T07:41:55.4743694+00:00",
"create_date": "2025-10-01T07:41:55.4743694+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-01T07:41:55.4743694+00:00"
},
"modified_dateutc": "2025-10-01T07:41:55.4743694+00:00",
"id2": 22
}