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": "e1ee8ee1-a4e1-4a77-ba00-f563789a113d",
"_parent_id": "886b4010-9250-46b2-a5ee-65b99b0b86f9",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "0ea703f8-49c4-4ae4-8a08-f15f67c19cd8",
"company_id": "7a8cd3e6-8c4a-4a72-afc9-894c43d76949",
"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": "b570a1c4-fcba-4a38-ad51-b6d9a9eb57d0",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "8a87e4ec-29ce-4532-892b-7e81d6282a06",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "03cdd122-1f8a-4efe-83f6-073f9871f921",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1ba51c39-9ed6-4bfe-bc89-6961172e311c",
"company_code": "sample string 5",
"company": {
"id": "a85af340-820e-43cd-9f20-f3b1de7c3fd2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-12T12:32:26.9001376+00:00",
"sales_territory_id": "5a1afe74-662c-4db4-b669-c9a396d3cc6f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9a7139d1-10a9-48a5-a99a-c927b7df4a78",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3435d227-8276-4ea2-ab2d-57a8606b3f99",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f488e355-d710-452b-ab1e-30d8a108acec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e23043e-f7bd-4e3e-8dd0-a87bd726165f",
"db_currency_id": "ddad37a4-a3e2-47a8-96b3-6c5508a02bbd",
"db_language_id": "79365ed2-e398-4d4b-a946-2039d4862142",
"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-08-12T12:32:26.9001376+00:00"
},
"modified_dateutc": "2025-08-12T12:32:26.9001376+00:00"
},
"marketing_segment_id": "b1cf9f2f-fbb3-4f19-b9f1-8382ce858643",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "22b4e5c6-8575-4d1c-92b8-a5b3731704d0",
"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": "e138cc94-d3e6-4195-a9c7-9cc1ce1ad605",
"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": "c2c5ca25-af71-4cfc-95d0-29c39ada21ba",
"db_country_code": "sample string 28",
"feelist_id": "170d085f-dea8-4049-b088-45ed992a8853",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f107dfd9-4fbe-4199-99fa-21574e1e9a10",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c92fdb88-292d-4864-ab06-db8106bf405c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-12T12:32:26.9001376+00:00",
"db_currency_id": "c243ae4d-1089-4498-aa72-f775f9cc2a1d",
"db_currency_code": "sample string 10"
},
"company_type_id": "bcdd6e7d-39d8-4ceb-85c8-1211c517e2d9",
"company_type_name": "sample string 32",
"company_type": {
"id": "0f59daec-a88d-4bba-987e-e7c24277d45a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2b03fec9-cdcf-4cfe-bf43-f2c3ca46f826",
"sales_organization_code": "sample string 5"
},
"db_language_id": "25e5b4ad-c00d-4611-a0f8-f97e7016e127",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cb962620-50e9-443d-8510-6b40154009d1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3ddc2ab7-1be0-46ee-97c6-b7bc66528470",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1b3d5c3b-767f-4e58-ba7f-a3787c5d3d52",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-12T12:32:26.9001376+00:00"
},
"company_sector_id": "5cb166c3-704e-4711-9b69-38a36fd3591f",
"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": "80c1d35d-964a-4143-9418-d874560a9ac9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cd28aca9-b510-4331-9b8c-c81ff29468f7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b2e621b6-f838-49a1-9a4b-453198ea1425",
"account_manager_user_code": "sample string 56",
"company_status_id": "6eb3207a-f5f1-46af-ac56-f94dd020af85",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-12T12:32:26.9001376+00:00",
"id2": 60
},
"db_language_id": "ce53fb85-9b53-4b13-85d8-36d1712405d6",
"db_language_code": "sample string 7",
"db_title_id": "5206fa0f-547c-4718-944e-eff828dab836",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-12T12:32:26.9001376+00:00",
"create_date": "2025-08-12T12:32:26.9001376+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-08-12T12:32:26.9001376+00:00"
},
"modified_dateutc": "2025-08-12T12:32:26.9001376+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": "b771e566-40e0-44dc-a4ea-34b3de34f8d1",
"_parent_id": "e4a7f0d2-820d-49d0-9177-c16c337aaad2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "50259372-4b06-4967-9ef0-89a219aaf5eb",
"company_id": "e0beccc9-05aa-4978-8262-1d4dddeb8be0",
"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": "4424be0b-be31-4bad-81fe-e83508369837",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d9b7989f-fb6a-4b4e-b627-70591c95d2c8",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a3f508c7-c98e-48de-8789-d8b08774f3ee",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "08721d4f-a8af-45dc-982c-e0ef140b809f",
"company_code": "sample string 5",
"company": {
"id": "77df2835-623d-418f-aaea-92e4c594b347",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-12T12:32:26.9001376+00:00",
"sales_territory_id": "7c882880-5e00-4978-abcf-6dbdd065face",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5de6d50e-b2be-43ab-bb54-463033b6f18e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c1230dc4-22b6-4d09-9c21-b9d9b6b6ceb2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cc8c1da6-fc14-4e20-b6c8-b2456b790dea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c86da537-a3e1-4948-ae1c-b0a625bcf526",
"db_currency_id": "66eadb46-c457-427e-951b-11ac4308f886",
"db_language_id": "795df99b-5507-467f-8874-3a6db64b8f08",
"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-08-12T12:32:26.9001376+00:00"
},
"modified_dateutc": "2025-08-12T12:32:26.9001376+00:00"
},
"marketing_segment_id": "9b9bd6e8-9e9a-4910-aaa7-8360faa22fa2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "25718d72-5005-48d9-bee3-f46125483d10",
"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": "81e75443-7943-4809-8e05-402fec0c4af9",
"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": "a39bbb32-df4b-4043-ad59-be6b8ff4cb71",
"db_country_code": "sample string 28",
"feelist_id": "cca61e0e-3fd6-43be-852f-5a0888eadc4f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "40803f98-ca4e-4e27-b3cd-8cb60d779ac5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d971b284-f630-49a4-8026-a8c91f20d3e4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-12T12:32:26.9001376+00:00",
"db_currency_id": "3db8d784-575e-4b0a-bdcd-96a1ac5e6791",
"db_currency_code": "sample string 10"
},
"company_type_id": "76b20bf3-8707-4031-9fe4-b188c13dd478",
"company_type_name": "sample string 32",
"company_type": {
"id": "16d6f725-50dd-4c66-871b-9059aa7a26dc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ef4703dc-d183-4eb1-a55d-fbc8b73e48c5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "57b25e2c-11cc-43d0-abae-cf9e302e032a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2a18bc06-ad02-4a0c-9c25-8f96b88f0db7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4ef69cad-88be-4ab7-8a38-398a1dfbb069",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f6789c0c-f6d3-42f6-a095-5c79966e1bd7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-12T12:32:26.9001376+00:00"
},
"company_sector_id": "1822c1a9-e329-457e-bb13-dde662cc6e75",
"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": "005c5266-1017-4b46-b0e2-daad3a77d2f9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "53106932-9306-4ee1-bdf8-ac3f45f8b87f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cb190b82-163d-455c-8b80-9864a302b5d6",
"account_manager_user_code": "sample string 56",
"company_status_id": "240aaf85-76aa-425b-906b-9bb9b8e7e354",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-12T12:32:26.9001376+00:00",
"id2": 60
},
"db_language_id": "5c5acead-528c-4dc4-a463-1df782edcf86",
"db_language_code": "sample string 7",
"db_title_id": "26eebd4a-5c86-4404-8fa2-4c983c6c9744",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-12T12:32:26.9001376+00:00",
"create_date": "2025-08-12T12:32:26.9001376+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-08-12T12:32:26.9001376+00:00"
},
"modified_dateutc": "2025-08-12T12:32:26.9001376+00:00",
"id2": 22
}