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": "261c2fbc-8027-42bb-a1ca-2832446e8bfb",
"_parent_id": "e7507ec2-0a0a-46e7-a217-48116083725a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "125682ed-1760-449d-a746-de312cc1c717",
"company_id": "9f485039-9442-40ed-8ab0-19d840be0de0",
"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": "32109750-56e1-4c59-943b-cb8a72d78166",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "75d735d0-fed1-443c-b445-2c57e3bcc27c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "36ffeb53-a56e-4766-b902-27358d1dd31c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "64fa7a8b-ea45-4c95-a8cf-8a6042eb3b31",
"company_code": "sample string 5",
"company": {
"id": "81f79ab5-38d1-4d96-b46a-cfc7e442b6c1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-21T10:10:36.7017008+00:00",
"sales_territory_id": "3a0fe26e-fac8-48db-82ea-44d048868db1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "40dc8af5-6b68-4b92-a06c-91394d882588",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "753899d1-a09a-4b87-a757-7936e3cc8b53",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1c90161d-1564-4f3c-9504-68899d9d5f8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "355e6cd0-8324-4176-ad5c-7edf0507e4fd",
"db_currency_id": "ebae757d-6f9a-4ac8-9397-f043a3cbaa4e",
"db_language_id": "ba710728-82ed-407c-a93c-dbc7dddf8b0d",
"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-04-21T10:10:36.7017008+00:00"
},
"modified_dateutc": "2026-04-21T10:10:36.7017008+00:00"
},
"marketing_segment_id": "afdddc78-ee21-4ef5-b26e-8bccc58d49d6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6e7a29f7-d80d-4491-8fe3-561fbd9e90c4",
"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": "7767d06d-6715-4ad4-b32c-d7243c0ec8af",
"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": "70c40958-b3f1-4a0c-8fd1-8a56aec4240d",
"db_country_code": "sample string 28",
"feelist_id": "3aa782c4-161f-43e4-93ef-b6baeebb93b2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "68dde3c6-6187-4ecb-98d7-0e29daea4fcb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cdc00242-740c-42ee-90d2-67867755138d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-21T10:10:36.7017008+00:00",
"db_currency_id": "a4355445-28c1-4635-a548-73d86c7f4927",
"db_currency_code": "sample string 10"
},
"company_type_id": "6488e5ea-84e3-4a51-856c-a6610a9cc8ef",
"company_type_name": "sample string 32",
"company_type": {
"id": "4ff495ec-6420-452e-bb7f-5148167f07ad",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "04fa3d54-b8d1-4387-9706-c4d8dd837686",
"sales_organization_code": "sample string 5"
},
"db_language_id": "edbb9287-8f72-46ea-81d9-c7522ca2cb79",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "89fbf872-a073-4008-b48e-8d5f2e60efbf",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "73ce2b47-be54-4854-ae87-5ab7c4aa27e0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "63b15f64-f8aa-4bd3-a18a-be03c1c58741",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-21T10:10:36.7017008+00:00"
},
"company_sector_id": "73b20894-2d6b-4176-8f91-611cd4a73879",
"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": "8bf823ac-cb90-4931-a4e4-2d0753e2eb6f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d689397a-f685-4bb0-bfc2-ada2b93e9b38",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "83447fb3-9844-416e-9355-7297a5dc2c22",
"account_manager_user_code": "sample string 56",
"company_status_id": "cda876e4-ff04-4ed6-b05c-32da3a077539",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-21T10:10:36.7017008+00:00",
"id2": 60
},
"db_language_id": "e2c6f5a5-9246-48d4-a349-7d8e9396a5cd",
"db_language_code": "sample string 7",
"db_title_id": "696d0c7e-483c-4e84-9a67-fe8470fc15aa",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-21T10:10:36.7017008+00:00",
"create_date": "2026-04-21T10:10:36.7017008+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-04-21T10:10:36.7017008+00:00"
},
"modified_dateutc": "2026-04-21T10:10:36.7017008+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": "f31bfba3-c79b-4bdb-a4d1-a48caa3858bc",
"_parent_id": "512f6477-ad89-43b1-ab23-e7407afe59f4",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "4fe7f86d-a5ea-44d6-a074-2038234ea949",
"company_id": "c2414a96-37c1-47cc-9e83-f2da36134a5a",
"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": "8111a22f-5a16-4f8b-a868-3e9b0504fb35",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "90c73603-2789-4244-90dd-b3760c954d1a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "7cbef148-eb78-4a82-92d9-e4ba92109a89",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f884f2d1-4370-4095-b4ff-100d5c29beeb",
"company_code": "sample string 5",
"company": {
"id": "9677685a-0430-4aaf-9cc6-bcddca0746d8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-21T10:10:36.7485821+00:00",
"sales_territory_id": "1adc557f-e4fd-4d03-88d8-0aa010dc13da",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f7576627-7453-4d35-b6e3-6ad829be132f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6daafdb1-b11e-4018-b0cd-a0db5581b13d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f4dfb1b7-a341-47f5-985e-ced77e80a83b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de7168d4-dcbd-41b7-aeb2-14aa935656a3",
"db_currency_id": "92d3560f-1765-4324-8541-7971f936ddae",
"db_language_id": "4554f464-f021-49f4-a2d4-ea8932389f19",
"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-04-21T10:10:36.7485821+00:00"
},
"modified_dateutc": "2026-04-21T10:10:36.7485821+00:00"
},
"marketing_segment_id": "d64e4d86-4c46-4341-bf64-007ee3519987",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "08364fc6-37c9-487f-971d-6f70d6fd92a4",
"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": "0c7eb0f3-6f72-4a10-ad62-c00a1eb7a2bf",
"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": "990375a6-59d5-41cd-8fc2-39652df14f76",
"db_country_code": "sample string 28",
"feelist_id": "6375e0a9-f615-4309-b132-a47c32525ad4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "790be39e-a9f8-4f0b-8033-0217df10b74f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0cb5d7b9-ed3f-4e98-a5d1-f64db5592405",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-21T10:10:36.7485821+00:00",
"db_currency_id": "37fe166b-bbf6-4fec-8e09-fd9f8c6456b2",
"db_currency_code": "sample string 10"
},
"company_type_id": "fc5e47ff-c27a-4e9b-9245-646fdcf8a2c9",
"company_type_name": "sample string 32",
"company_type": {
"id": "1bbd7c1b-be0f-4a4e-92d5-37e579a981f0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "90b2544b-ea7c-44c6-b856-d77b060d1062",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e7118a79-7936-42ca-8a46-6e80c8839b54",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8329110d-a63f-4e2c-b31c-b2fb6a2d1d64",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4891f1b4-2b12-4117-b067-2f2109e985c8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "78603c06-c565-436e-8516-bad2293442cf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-21T10:10:36.7485821+00:00"
},
"company_sector_id": "8091293b-4643-4d58-837b-e9a9eada0137",
"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": "9da1264e-a960-4489-bce3-c600a8f1c787",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bbc2dc3d-d9fb-4eab-ad0d-6ef4b401927b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6108942d-f37b-4487-a797-33b6bf0512a5",
"account_manager_user_code": "sample string 56",
"company_status_id": "433ddc4f-a124-4958-885f-31fe370c69e2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-21T10:10:36.7485821+00:00",
"id2": 60
},
"db_language_id": "46ed5225-19e1-46dd-85b8-6e798dc5bb45",
"db_language_code": "sample string 7",
"db_title_id": "1d27e5aa-6b4c-4dd6-9937-f1616bc38694",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-21T10:10:36.7485821+00:00",
"create_date": "2026-04-21T10:10:36.7485821+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-04-21T10:10:36.7485821+00:00"
},
"modified_dateutc": "2026-04-21T10:10:36.7485821+00:00",
"id2": 22
}