Creates a new location object
Request Information
URI Parameters :
None.
Body Parameters :
locationName | 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
{ "id": "fa4afafd-dc0b-4786-bc63-34738a941a48", "_parent_id": "e3e30a86-29e0-4b45-ae46-60e5580ede2f", "_parent_reference_back_office": "sample string 3", "project_status_id": "3f7c057a-6f2a-43bd-bb42-66d36b8ad1c0", "company_id": "3ddf8509-5fcf-4d12-98af-4780a104d565", "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": "b4d055fa-693f-48ef-9830-5abc7edb1253", "db_country_code": "sample string 17", "street2": "sample string 18", "latitude_decimal": 1.0, "longitude_decimal": 1.0, "contact_id": "137339da-236b-4a96-a63c-60e4f4732728", "contact_reference_back_office": "sample string 20", "contact": { "id": "14e399a5-b5dd-4c0b-ae2b-df04bbf9d5e8", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "49845275-02b5-4e0f-8f64-f1612a493a7b", "company_code": "sample string 5", "company": { "id": "aa8393c1-2aa2-4848-9991-54fdb68b9ecf", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-07-03T04:48:13.5928402+00:00", "sales_territory_id": "58fb0ea1-7bac-428d-a261-8d6225abbf3b", "sales_territory_code": "sample string 9", "sales_territory": { "id": "54f2f3bb-e13b-4c9a-812a-cb4bb97ab1f6", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "0620250d-11ef-4cc7-9543-f657135f8fa6", "sales_organization_code": "sample string 5", "sales_organization": { "id": "eda41961-7bc3-4999-8983-a573331f2dc8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6294a255-626b-4f5e-b17e-b1bedd4d47a4", "db_currency_id": "0a1a406a-993a-49f5-8fce-f0cc25927fdb", "db_language_id": "d8b22b09-b8a9-4b58-939e-00fa709a5e07", "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-07-03T04:48:13.5928402+00:00" }, "modified_dateutc": "2025-07-03T04:48:13.5928402+00:00" }, "marketing_segment_id": "c199833c-ce4e-49e1-8951-4fed735b3c61", "marketing_segment_code": "sample string 11", "sales_organization_id": "ad7a4480-5e46-4541-a48d-64b617f39248", "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": "a8a971ae-4c96-4619-b1b9-08664ef295b6", "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": "1c37749a-860e-4561-9f1f-3fdde6057d87", "db_country_code": "sample string 28", "feelist_id": "01d92ef9-1495-4bd1-b555-c02e148eb400", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "7f64ac1c-c29f-43d6-8a94-a08df3c2210b", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "85fc8e78-5aab-496a-bf62-1853b392b660", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-07-03T04:48:13.5928402+00:00", "db_currency_id": "3b7c4350-302d-43e8-a022-1d2d74e714dc", "db_currency_code": "sample string 10" }, "company_type_id": "38fe1c0f-ecdb-4281-961b-d4969c1aa864", "company_type_name": "sample string 32", "company_type": { "id": "e479e7ca-5aec-4461-b9af-dbea470d8477", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "628f6324-166b-4ede-b6a1-913d6fede637", "sales_organization_code": "sample string 5" }, "db_language_id": "549ebad5-f48c-4ee6-81a1-0f3dd3da3ea5", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "83473a3a-e95d-4d8f-95e6-5a11b286bda4", "article_price_label_code": "sample string 37", "db_payment_method_id": "f6a60c39-3fa9-447d-b675-029bdc433bbe", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "f698b381-b4a4-491b-a30e-c5fd52e0f1fc", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-07-03T04:48:13.5928402+00:00" }, "company_sector_id": "14622af2-31a3-43f3-9272-3df3144baffb", "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": "63300099-fb17-4a3e-b9c2-c87c6c76ec37", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "b397be04-c7bb-4482-bfe2-009275c13434", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "508df733-babb-4397-8ce6-1a48f9d5c043", "account_manager_user_code": "sample string 56", "company_status_id": "92e68d74-cc2c-472a-a605-12af8154af97", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-07-03T04:48:13.5928402+00:00", "id2": 60 }, "db_language_id": "d6ca8d49-b30e-4b58-b47d-3bd5b64b0b20", "db_language_code": "sample string 7", "db_title_id": "5896f3da-b151-4fae-b29b-83b82f8a7f7a", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-07-03T04:48:13.5928402+00:00", "create_date": "2025-07-03T04:48:13.5928402+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-07-03T04:48:13.5928402+00:00" }, "modified_dateutc": "2025-07-03T04:48:13.5928402+00:00", "id2": 22 }
Response Information
Resource Description :
locationName | 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
{ "id": "29df3cd0-5c42-4c5e-ad65-d91f0ff74957", "_parent_id": "3e1126ca-68ac-4d14-be7b-98ded6090214", "_parent_reference_back_office": "sample string 3", "project_status_id": "752cdf9b-645f-4efe-af38-4842e82491c1", "company_id": "d8e408b2-153d-4cd1-94be-654d45595487", "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": "6b895ff6-44bc-42f3-8658-ebf859cbb7b3", "db_country_code": "sample string 17", "street2": "sample string 18", "latitude_decimal": 1.0, "longitude_decimal": 1.0, "contact_id": "130192cd-aba1-40ed-b5ec-a4952f0aea63", "contact_reference_back_office": "sample string 20", "contact": { "id": "beb8a7e1-54fb-467b-bc45-cdea779fc3ba", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "670b1dce-7acc-4cb5-b8a3-af1a7cb556e5", "company_code": "sample string 5", "company": { "id": "583c6ab6-bc95-4935-a2a3-ea54f51f2618", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-07-03T04:48:13.5928402+00:00", "sales_territory_id": "d9a2e593-7f7a-459e-a8d6-b0ee4d0fd160", "sales_territory_code": "sample string 9", "sales_territory": { "id": "be474b2f-7503-4be4-b022-f7459719da88", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "149c123e-705d-4c26-bb01-42ac87538751", "sales_organization_code": "sample string 5", "sales_organization": { "id": "b0593745-96da-4334-8528-de646e5b2fff", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d53e6fb3-b98e-4b97-b67f-625ed4611f45", "db_currency_id": "8920a128-5798-4393-92ef-89aa7b3d9e5e", "db_language_id": "36a30d28-50e1-4f3f-b10e-296df87a1936", "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-07-03T04:48:13.5928402+00:00" }, "modified_dateutc": "2025-07-03T04:48:13.5928402+00:00" }, "marketing_segment_id": "b6066273-1d92-42d2-87a4-a6bfb15e11dd", "marketing_segment_code": "sample string 11", "sales_organization_id": "1da5ddb9-8b05-4d41-9a3f-1d2e0b04d036", "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": "963692a5-1156-45bd-9056-09605e4b078e", "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": "c52a3302-c1d6-4588-abd3-4be1bcd3acd0", "db_country_code": "sample string 28", "feelist_id": "a3f5e26e-fd3b-4cac-bf5e-d40cee161837", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "f4d93487-de12-4e09-b86d-b6bafac7d50f", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "32f2cfb8-09ac-4962-9cf0-c12a55c41f25", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-07-03T04:48:13.5928402+00:00", "db_currency_id": "a06f013f-025a-4a18-9873-38d10702ed9e", "db_currency_code": "sample string 10" }, "company_type_id": "4320384b-8b9e-4f8c-a0d9-ce024b14f789", "company_type_name": "sample string 32", "company_type": { "id": "fb55aeb9-23c9-40c6-86ba-8e51a5d9be17", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "0394a290-cd3f-4678-a73c-4b3809da7efa", "sales_organization_code": "sample string 5" }, "db_language_id": "fc9a401a-e3b9-47f6-a785-6954cb2ca428", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "021cea9e-5142-4c43-b6d7-d3544bcef512", "article_price_label_code": "sample string 37", "db_payment_method_id": "f543694b-6bfb-4973-ac90-24ef897f57cd", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "c094cd0f-8399-4659-8b42-028b8449204e", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-07-03T04:48:13.5928402+00:00" }, "company_sector_id": "7ed78433-d88e-4d23-8e5c-913ba1d50517", "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": "32a80eb8-b17c-4d3b-a780-833e4f6e0f02", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "e861150f-bc86-4a08-9e2f-971343a18d66", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "0bbf5e7b-7902-453b-8dcf-1405277cfba9", "account_manager_user_code": "sample string 56", "company_status_id": "12bce0fc-22bd-438d-9a01-31b633fe70e4", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-07-03T04:48:13.5928402+00:00", "id2": 60 }, "db_language_id": "1b9b6892-20d3-403d-a041-e33790a979e9", "db_language_code": "sample string 7", "db_title_id": "2ad3c2b4-2824-4e03-8c66-956b3cdc4b74", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-07-03T04:48:13.5928402+00:00", "create_date": "2025-07-03T04:48:13.5928402+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-07-03T04:48:13.5928402+00:00" }, "modified_dateutc": "2025-07-03T04:48:13.5928402+00:00", "id2": 22 }