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": "b5426c9b-ce5c-40c7-a1c8-2ced4f363e04",
"_parent_id": "9639350b-522e-4136-a8ec-70cbd181a600",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "20bf5b0a-ff24-4639-b76a-b995acc2db4e",
"company_id": "7d2e1f66-9230-4121-931c-e5e4d868ca75",
"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": "a9580e38-3e19-4b98-87ee-aad3b787122c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b325b15b-49aa-45e5-89bd-ed52d36fce88",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c0345bf9-7836-426e-9d87-37f0ea6f2ca0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0cd45111-9179-49c0-b6f0-acf7c3d16332",
"company_code": "sample string 5",
"company": {
"id": "c52018d3-6c1a-4c61-b127-9ac0f17447c9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-20T09:18:48.7745869+00:00",
"sales_territory_id": "017731aa-90b1-47fb-97a7-2304bc87355d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8791c794-ac1b-4dfd-b906-cde5e8177eaa",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "274a7c4c-15ff-43e9-b633-05fff8ebe68f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "94dd3aca-d40b-4ce0-948e-69991c76c2d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "20542931-a554-413c-a43a-90fc2cd5ab5b",
"db_currency_id": "6fbe7b91-c556-465d-8576-caa2ae506b33",
"db_language_id": "86a21642-c291-44d1-9125-1d118adffed9",
"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-03-20T09:18:48.7745869+00:00"
},
"modified_dateutc": "2026-03-20T09:18:48.7745869+00:00"
},
"marketing_segment_id": "e3f8eec1-d4fe-4340-869b-0d95f6f5f0cf",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e681a1e2-f435-4262-851f-4e67dda86a1e",
"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": "312d6659-2aed-4486-b27a-37f696c60efd",
"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": "6111b4d1-199e-4b1c-9089-53bb9901c8f6",
"db_country_code": "sample string 28",
"feelist_id": "2f0c596c-2ab7-4198-b470-9f0575799e7f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7e2f9a8d-61e2-48c6-a8bb-0ec53da79da3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "542dc0f3-27f0-4167-86f2-5f076e53c46a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-20T09:18:48.7745869+00:00",
"db_currency_id": "64d2fd00-32b7-4650-8d6b-1711205522c8",
"db_currency_code": "sample string 10"
},
"company_type_id": "c65e3a31-7ff6-4414-b274-97ed2b79d1f8",
"company_type_name": "sample string 32",
"company_type": {
"id": "ab6e56f2-f6f6-4363-aeb1-a73a1cecd399",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3337611f-026d-467f-95bc-dde7bc8c3222",
"sales_organization_code": "sample string 5"
},
"db_language_id": "10209b59-5e0a-482c-9efa-a21af8a3fa67",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e09c1c9c-17cc-4e20-8314-33333b2374e8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5f64d818-5f04-4822-8058-90aee7ea80e9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "eaae96dc-f260-49ff-a105-ef5b72fdafc0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-20T09:18:48.7745869+00:00"
},
"company_sector_id": "b4d562ea-5243-4ff3-8739-efd4d9d57c16",
"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": "d1dd240f-f0fe-4cf8-bbd4-0bafc54ec75f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "abc25cd3-2984-49d7-a0bc-4933a75d9de4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1f973a77-a36d-4829-8a23-56cb70d34d01",
"account_manager_user_code": "sample string 56",
"company_status_id": "9428ebd8-cd3e-4877-893d-f35200e4b46c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-20T09:18:48.7745869+00:00",
"id2": 60
},
"db_language_id": "89fe1ce1-29c4-41a9-9f72-2c3f54418d20",
"db_language_code": "sample string 7",
"db_title_id": "f0930d90-b4b1-4e48-8209-5bf7da82618d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-20T09:18:48.7745869+00:00",
"create_date": "2026-03-20T09:18:48.7745869+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-03-20T09:18:48.7745869+00:00"
},
"modified_dateutc": "2026-03-20T09:18:48.7745869+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": "1032e0f5-49ce-4bf9-bb24-bce8b607405a",
"_parent_id": "22bcaca1-519d-4e43-a822-6356bf582a5d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a69f059e-8c59-43f9-9a13-f2b3c0ca318b",
"company_id": "2302753f-7109-41ec-8067-8e8343649377",
"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": "8e370364-66e3-4898-a34b-7838b0ef31e9",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "004fb834-1ed8-477a-9342-0488136680d9",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e4fe968d-25b0-4dda-b95a-b86bd24adba2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b279be3b-f772-4583-a1fd-9b3a97d8cc7d",
"company_code": "sample string 5",
"company": {
"id": "8abe95f4-bbf8-49d2-a272-5dfdd3e50e5c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-20T09:18:48.7745869+00:00",
"sales_territory_id": "2253a352-01f7-4723-b43f-9f8cc6694f31",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "22862c85-d81f-4d75-b600-a085d4b82051",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "49be0589-537d-489e-99ec-cae954bc1bf9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "16857636-6b15-464d-b226-43d954cd477c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "412b72e4-d183-4d3d-a9c8-d8f99d082b16",
"db_currency_id": "1b10e221-8e54-4033-91c4-04832791aba3",
"db_language_id": "f62d1868-6c98-46a1-a129-a5eb197d3c91",
"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-03-20T09:18:48.7745869+00:00"
},
"modified_dateutc": "2026-03-20T09:18:48.7745869+00:00"
},
"marketing_segment_id": "15739b98-863a-42ed-b17f-71962dfa137b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "093f1f2c-7c7f-49fa-b08b-f51653216742",
"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": "90964147-ef11-467d-9c6c-d88d0ddefd5d",
"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": "d83d71fa-a5b6-4066-a445-30bd136730f6",
"db_country_code": "sample string 28",
"feelist_id": "2a24837c-28d0-45fb-80bd-9e55ac9c64ed",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f56d280c-e30c-4d8b-a5ab-36915bf1e1e2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8d2ed594-dc75-493e-b285-d4095727e8f4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-20T09:18:48.7745869+00:00",
"db_currency_id": "eb7165fd-14e0-4c34-baf8-594b5afe7b5f",
"db_currency_code": "sample string 10"
},
"company_type_id": "b552a125-223a-4f83-9cb3-09b9908ae583",
"company_type_name": "sample string 32",
"company_type": {
"id": "ee2ae956-1ea2-4306-a6ba-0db2ef5664c1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f732803a-6d58-4dc9-9096-b593b8f6df8d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2f089b1a-f6e9-4d36-bba9-a1135e91a2f8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "62edbed0-d8c5-45c5-948e-98446d08bfae",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c71e5de0-f512-47ea-86a7-8fc72ddf9db0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4595b503-4098-4828-978b-edc05ab54a2f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-20T09:18:48.7745869+00:00"
},
"company_sector_id": "7964bf58-98d7-4a43-802c-4e4c8139a7b1",
"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": "821f77ad-10a7-45a6-9c73-038f0c87085f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8ab5bab3-9b5f-41fe-880b-d1597c87f6dd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "28ebe850-c18a-48f4-8bd3-b824309ef39c",
"account_manager_user_code": "sample string 56",
"company_status_id": "9acc3b5e-6ebc-4ab6-ba65-3487577a56eb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-20T09:18:48.7745869+00:00",
"id2": 60
},
"db_language_id": "c3e8a592-2d0f-4e62-a52f-782f1275cc79",
"db_language_code": "sample string 7",
"db_title_id": "a8dada11-f8b7-42c1-b659-c2744cb58b70",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-20T09:18:48.7745869+00:00",
"create_date": "2026-03-20T09:18:48.7745869+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-03-20T09:18:48.7745869+00:00"
},
"modified_dateutc": "2026-03-20T09:18:48.7745869+00:00",
"id2": 22
}