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": "cf697c2c-3f0f-4239-baf0-ceb580c6f153",
"_parent_id": "2b21384d-60e7-46d2-a24e-f0f8adb9c85d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "8f041163-3e0c-44b2-8990-319a94c6a9b1",
"company_id": "9e57b9fa-1b0d-4e89-82eb-70565b794a35",
"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": "429ee31b-fc48-4e0c-bafa-821233731147",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3171dda0-fb89-4d35-aeae-e3484c784035",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "79262d37-c459-4308-aa17-5a36b13c61a6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "36773851-0799-4a87-ad5d-94b953a7f8c2",
"company_code": "sample string 5",
"company": {
"id": "b3fff661-4da2-4706-9d70-804b006f939e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-05T18:48:31.5323394+00:00",
"sales_territory_id": "87a0eae8-57e8-4aa4-8418-72a328200b28",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "58988d19-cf60-4467-8b65-d7926ffc1e0f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "06743043-67d9-473f-a983-f0daba83ac0a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fb28481a-234f-4fd7-9a1b-c9851b748797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "27cf6de2-3ef1-4cc6-b067-2fbff34a45ca",
"db_currency_id": "72f715dd-e76f-4dba-9a64-4df2f8568b21",
"db_language_id": "05e25e61-7379-4b89-9f70-d31eeaec73b0",
"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-12-05T18:48:31.5323394+00:00"
},
"modified_dateutc": "2025-12-05T18:48:31.5323394+00:00"
},
"marketing_segment_id": "9b299d87-1ed6-48dd-85b6-9e6957b47922",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e07a8a1c-8c83-44b2-9424-68bb6ad54cf3",
"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": "cdbccd18-e778-406c-b778-28c074ecc132",
"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": "405ea5ae-5481-467f-8302-6203ba32299d",
"db_country_code": "sample string 28",
"feelist_id": "881339f6-6c21-493e-a974-56a125c882c1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "da098bca-7852-4f05-9de9-127ce7c69248",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8f71c03c-e949-464c-a106-71e1a1e63d4e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-05T18:48:31.5323394+00:00",
"db_currency_id": "25eba921-ee41-4c40-a258-15e4feebd295",
"db_currency_code": "sample string 10"
},
"company_type_id": "30e9de8a-85b6-4083-9d69-e0dce8044831",
"company_type_name": "sample string 32",
"company_type": {
"id": "c5785578-013c-48a0-80f7-ea673f5c0daa",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8c2915d8-220a-414e-a248-05d315a645d0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ef974849-dc00-4e63-9d2e-5415a51dffa0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "79d86c78-cbfd-4159-9b98-ec8a4a0f85cb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5f4d8ba9-040f-4c95-ac79-5e17d89f4fe8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "94512b5f-6775-42fd-9845-76814d9acdf8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-05T18:48:31.5323394+00:00"
},
"company_sector_id": "0f6e9fcd-b58e-4932-b462-6efed57d0c12",
"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": "534274ba-7a80-4035-aadb-cf628519898b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "60ab30e0-5c6c-499d-966a-7628bf366968",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "114eba19-dd46-479b-a889-01c1578f1bac",
"account_manager_user_code": "sample string 56",
"company_status_id": "bdfb4ee5-df80-4dc9-bd6a-5cf4c85a3b69",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-05T18:48:31.5323394+00:00",
"id2": 60
},
"db_language_id": "6e11cbdf-6486-4bba-b607-989a9e1a214e",
"db_language_code": "sample string 7",
"db_title_id": "ed1ecd40-4ea7-452d-82d4-04e6ed2341e5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-05T18:48:31.5323394+00:00",
"create_date": "2025-12-05T18:48:31.5323394+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-12-05T18:48:31.5323394+00:00"
},
"modified_dateutc": "2025-12-05T18:48:31.5323394+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": "2644faf4-9e37-41a9-ab6e-69ed75679556",
"_parent_id": "6888d3a1-12f2-4347-b077-d5710f12cbe9",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9cebf53e-f910-4ee3-b0a4-3f5a6afa3be5",
"company_id": "7e72927b-ad62-41d4-a63e-089c3864da98",
"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": "8ea47564-cb92-454e-99c0-abc1cc28aa9e",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "4d301a7e-5e15-4bfa-b3bf-81acb676d4d3",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3ec04ac9-7ea6-4ed1-b5b8-5342307cf424",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e6db1647-c269-40b9-b177-8204a5d205cf",
"company_code": "sample string 5",
"company": {
"id": "28c98a0b-0d6b-4666-b8de-d4e3825d5c7d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-05T18:48:31.5323394+00:00",
"sales_territory_id": "89281152-80d3-4e35-afc6-f03c764ccf98",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5f6665b6-ccda-4a64-922f-3539c400c69d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "94fe7ae0-64f8-430c-8d89-0532eb9cc492",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "049efe42-6f92-4d33-9dd8-3c824b66b0b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd62d797-c600-4df9-b2b9-7d7c47af14a6",
"db_currency_id": "29306ce4-1f6b-479c-9615-cb490f60b9fe",
"db_language_id": "b75055dd-805a-4f75-96d7-e092c13517eb",
"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-12-05T18:48:31.5323394+00:00"
},
"modified_dateutc": "2025-12-05T18:48:31.5323394+00:00"
},
"marketing_segment_id": "9637a0c7-d9c3-494a-bf6a-6588ed1bd0a3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5102418b-39a6-45ea-a770-04dccf21d687",
"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": "5a75a54d-5531-4d8d-84b5-5dfe1df240bd",
"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": "52f80420-3b49-422a-af50-b18fe7a4072f",
"db_country_code": "sample string 28",
"feelist_id": "71fce2cb-f520-43dc-8d48-dfcb69a520ca",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d4b68dfe-00cf-4b96-8eb5-9393fd8882c9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9b388f01-ef74-446c-a390-b9c5bfacf3fa",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-05T18:48:31.5323394+00:00",
"db_currency_id": "6e55deec-dbc2-4c17-a824-096917624c98",
"db_currency_code": "sample string 10"
},
"company_type_id": "b97351bf-189d-4787-9e1f-68eee985dfff",
"company_type_name": "sample string 32",
"company_type": {
"id": "58e0cd2e-3763-48f0-ac70-b8da50324709",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9b43b015-4f7e-4bfa-be50-286515da901e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3b0c2f1f-7e2c-4757-bf11-e0f45750a0f0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d7a3bc7c-b23a-49c1-9e6a-709d9d374146",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "edecf422-4567-4803-b668-590857a94c17",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "00465b93-20a8-455a-bc09-5df8f5c465f9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-05T18:48:31.5479642+00:00"
},
"company_sector_id": "7d641640-78fb-4142-9887-80c745b7f362",
"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": "aeb332c6-4b5c-49cc-9d4e-764c08ad0473",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a70bf60c-a1f1-4af1-be33-88746027fc8a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f7a0a3ba-8a6f-46f2-b9a6-04fff9053cd1",
"account_manager_user_code": "sample string 56",
"company_status_id": "bea93ca9-4dcc-4a7c-b2fe-724a0a9452af",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-05T18:48:31.5479642+00:00",
"id2": 60
},
"db_language_id": "8babafc7-2b9d-433f-9c23-4f9f62581074",
"db_language_code": "sample string 7",
"db_title_id": "ce421b23-56f5-4fe9-bf09-dc3ffd453142",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-05T18:48:31.5479642+00:00",
"create_date": "2025-12-05T18:48:31.5479642+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-12-05T18:48:31.5479642+00:00"
},
"modified_dateutc": "2025-12-05T18:48:31.5479642+00:00",
"id2": 22
}