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": "24c4d5da-82dd-4be8-ae09-163401b5f58e",
"_parent_id": "33a0b868-86b7-4ea0-9db5-70aa170a491c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b61e3b5a-9c2d-49da-b121-8ea4d083e16c",
"company_id": "22d36c10-8522-4731-8b05-d2141e745e65",
"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": "5a2e0c40-1a90-45ef-8da5-0811ce216edd",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b9dbcec8-f397-42a2-b02c-faf2c0e53d77",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2da0b8d8-bddd-4d3d-b5b2-574ab7469e94",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8f26d8f4-f618-4cbd-aed0-3ff95504ff02",
"company_code": "sample string 5",
"company": {
"id": "96377770-1376-447b-afca-d2df12b0145e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-17T19:25:47.6624593+00:00",
"sales_territory_id": "d59d3d7f-bacc-415e-b9c4-3933e7c65fd6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4bfc34da-5523-41eb-a530-8954c973b02a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "67fe76ec-4271-4f38-96a4-3c17bedcef99",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "49571be8-9ca3-4d62-9308-908beeec6bb6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ce63ccc0-c3c1-4283-8b8a-e438d7ecfb8e",
"db_currency_id": "cec9c5b2-09f2-4525-9980-98425ce482d9",
"db_language_id": "919dac07-132a-40df-b38d-e368c8d40cbc",
"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-11-17T19:25:47.6624593+00:00"
},
"modified_dateutc": "2025-11-17T19:25:47.6624593+00:00"
},
"marketing_segment_id": "c43ad8e2-6e9c-49cc-9656-87d40d230ff5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9fffe2dc-8de2-469a-9fac-a57eab4e4da9",
"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": "3dc36e75-2799-4282-bfb9-cb12ea9386d6",
"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": "33aa745c-ca1f-4939-93df-99527d5e127d",
"db_country_code": "sample string 28",
"feelist_id": "866d2df0-a6c1-4342-a8fe-bd20d08bf5f9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9be85d02-1709-463d-9e93-3c99130779f5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a0e19e92-8326-492b-bff9-71b20517a51d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-17T19:25:47.6624593+00:00",
"db_currency_id": "ddae820f-bc00-40b4-9e71-a8f2c852d3f2",
"db_currency_code": "sample string 10"
},
"company_type_id": "8613360b-2c78-467c-b595-e04eac18e4d9",
"company_type_name": "sample string 32",
"company_type": {
"id": "07ff401d-cd29-48a9-8351-84a100d54046",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5a1c0712-834c-435f-9296-d30a51551db2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c83872da-3ba0-4df1-9c0c-15efdc43a485",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1c3fafb6-40a7-4564-a7e9-4a4002331c4b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0713c9fd-4c7b-4e7b-b141-70088598701a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c08ca423-3497-4a71-a808-27ee4e163878",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-17T19:25:47.6624593+00:00"
},
"company_sector_id": "9100d59e-9392-4364-ae69-954886221e45",
"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": "9408ae72-998a-4281-94d9-b7af363ac759",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1c37e46b-4911-4b23-8630-2459705d47a6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "145edfdb-2027-4238-ad8d-ad6d13526b60",
"account_manager_user_code": "sample string 56",
"company_status_id": "de469171-3b19-4c18-ac70-f645780374c5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-17T19:25:47.6624593+00:00",
"id2": 60
},
"db_language_id": "9a896971-ff3a-4505-8b5f-0ad78509ced4",
"db_language_code": "sample string 7",
"db_title_id": "c0ea3209-8de0-489b-b99b-cb29cc43f996",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-17T19:25:47.6624593+00:00",
"create_date": "2025-11-17T19:25:47.6624593+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-11-17T19:25:47.6624593+00:00"
},
"modified_dateutc": "2025-11-17T19:25:47.6624593+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": "fb81fbf0-ca60-4a21-afd9-b1e0978fce9b",
"_parent_id": "9fa9de96-2f54-4d1b-a20a-366c3baebb57",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "0c78a0b2-81f0-4af7-a739-df87b76cab12",
"company_id": "102a88ca-b010-41df-a6a1-856ce32ec466",
"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": "74864781-1853-4ebb-92c9-646d53ce208b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e17e0f73-95aa-4876-99ec-0cf86b417a52",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3fd19bdd-d929-4aa1-8586-0685a5995463",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e97afe78-4993-4768-999c-edb5aa4eef86",
"company_code": "sample string 5",
"company": {
"id": "ec7a3c77-816c-4157-8569-5f556b3a6e2b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-17T19:25:47.6780821+00:00",
"sales_territory_id": "57ff3663-a681-4d0e-8162-5005fbbe6a74",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4cf76328-27f4-43db-ba54-84dcebfda3e1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a1d77b2c-e15d-474f-9b74-62b10015689d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2849a5f2-dceb-4d43-961e-5be7a58a9157",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "000f89dd-06f6-48e5-a651-2fe3d5e18858",
"db_currency_id": "da45f10c-d7bf-443f-9b91-abfc515f5cc8",
"db_language_id": "11f4fb31-8d8b-4e2f-bb75-58e1682e6f82",
"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-11-17T19:25:47.6780821+00:00"
},
"modified_dateutc": "2025-11-17T19:25:47.6780821+00:00"
},
"marketing_segment_id": "b063ad4f-35ee-4a53-9726-3dd63da35d0c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f08637b0-bfc1-457c-a6df-e249ab40db7f",
"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": "763fb800-9c4c-485f-8e5e-5835665dd957",
"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": "273159b3-f0cc-4e96-bfac-3df550833b6e",
"db_country_code": "sample string 28",
"feelist_id": "6aadc4ed-ffe9-4cba-b517-b56786fe1ca4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "25155e28-8997-40a2-800b-e0e6a414bb8d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7d146ce7-d183-4395-98d9-896145203b20",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-17T19:25:47.6780821+00:00",
"db_currency_id": "52c05d8e-db43-466c-90dc-aa69c78f5de7",
"db_currency_code": "sample string 10"
},
"company_type_id": "ed2c025d-8da2-45e2-aeeb-900c60292ee8",
"company_type_name": "sample string 32",
"company_type": {
"id": "dbb14520-8abf-4894-b612-216d64171a32",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dfdc9944-caa4-411a-9609-04c011b9cadf",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a8bd09d8-0f18-4bb4-a760-83a8889b5121",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "33caed75-2489-4404-89a6-23f3798e9221",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3f6eab05-3521-49a0-a92b-abb925803782",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "cf1d429c-1670-4a38-a205-f021759fe3db",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-17T19:25:47.6780821+00:00"
},
"company_sector_id": "5715b558-0a53-4ad2-a787-f7e1f7a7560e",
"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": "eaa36013-b917-49dc-881c-8a39f47c5a56",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "41ea7fcf-92cc-4c07-b950-d8bff47a7dc4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8f2c3394-1cf7-445f-bc49-f63ac66de80a",
"account_manager_user_code": "sample string 56",
"company_status_id": "1a1e054a-bf24-4ff7-a42a-e63495eb16b3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-17T19:25:47.6780821+00:00",
"id2": 60
},
"db_language_id": "91f3f90c-f646-40ea-a7dc-640125c2698c",
"db_language_code": "sample string 7",
"db_title_id": "4a9e72e6-4783-4247-913f-58e41450d114",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-17T19:25:47.6780821+00:00",
"create_date": "2025-11-17T19:25:47.6780821+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-11-17T19:25:47.6780821+00:00"
},
"modified_dateutc": "2025-11-17T19:25:47.6780821+00:00",
"id2": 22
}