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": "b7dc4fbc-436c-4a53-a41a-d64579dc0681",
"_parent_id": "93601723-6244-47db-8909-3da127600e89",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "99e28490-9cb1-4fd6-a626-6a843b80a024",
"company_id": "8854dbd0-4142-4192-a2d9-ed0d766d75ca",
"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": "9720cc12-b9c2-45a8-8fd3-2b06b619f853",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c9929397-1c2b-4613-b471-ad359a9af96d",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "1c15e9ea-38a5-42f9-8b79-ac067929ba06",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1d8330e1-b06d-4ed3-bb54-383ce1baa08c",
"company_code": "sample string 5",
"company": {
"id": "0008d281-a07c-4f5d-abde-7a7912db9f62",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-23T19:29:08.7758262+00:00",
"sales_territory_id": "77784bcb-b40f-4e25-92b0-33b1ca3f451b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0ee4189f-0510-49bd-87dd-f730e0fe09d5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0f926040-7533-40ec-8d14-5fd569d25d7b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "24da92ac-db41-4180-a684-6d2fa475ad85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "428af2ee-50e7-4779-842e-b8358607a309",
"db_currency_id": "409ca660-2b7e-4856-a13a-3c09adab66bc",
"db_language_id": "81c909a1-c1f1-4524-9eae-3dc835e7d36a",
"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-01-23T19:29:08.7758262+00:00"
},
"modified_dateutc": "2026-01-23T19:29:08.7758262+00:00"
},
"marketing_segment_id": "9e58d6ce-3a63-422f-99c2-a51ea351720b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c997e18c-b349-43a0-bbb1-812d21b73c14",
"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": "051bd883-cc18-49f3-83f3-6e8a58fd02ab",
"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": "4aea42cf-7185-482b-94b3-fcfb23e8df91",
"db_country_code": "sample string 28",
"feelist_id": "6ce6388c-e4a2-4894-aefe-9d756bdeb77b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8cd8a318-dc83-43f4-8d00-05bfb161084e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "79cfa285-6f15-4c5e-9269-9210ee162822",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-23T19:29:08.7758262+00:00",
"db_currency_id": "02d78ba8-f2a8-459f-8e7d-2627dab8f5a4",
"db_currency_code": "sample string 10"
},
"company_type_id": "f6334c3d-62b1-41db-abb9-1a7be33d54c6",
"company_type_name": "sample string 32",
"company_type": {
"id": "1eabd982-69be-4fad-b9e8-547e760f15ac",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f30c6271-0565-4205-9fed-4a4380daa5ad",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c4f09000-e93d-4083-b051-990a5f7efeb2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "72ecbade-f452-4e4e-8d38-82862dda69fc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "509611d4-35a1-46d4-875f-f39bfdb200f0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d1314121-5370-4488-bc18-6852855623e4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-23T19:29:08.7758262+00:00"
},
"company_sector_id": "a868222e-6cae-4713-b911-5eb83856eb2b",
"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": "4759747a-cb2e-4484-83ad-39bb98d6a03e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a1ff6385-e77b-41fb-bf37-0f246d8cd7f4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e073cf7f-37b1-4bb1-903e-39b88b0bf3a9",
"account_manager_user_code": "sample string 56",
"company_status_id": "9721f674-30bb-47d9-8b2f-7fd1fc166e44",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-23T19:29:08.7758262+00:00",
"id2": 60
},
"db_language_id": "7c43c71a-469d-4cc9-b78b-e697295c182a",
"db_language_code": "sample string 7",
"db_title_id": "99dcf006-65e3-4264-ac30-bc38f902df55",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-23T19:29:08.7758262+00:00",
"create_date": "2026-01-23T19:29:08.7758262+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-01-23T19:29:08.7758262+00:00"
},
"modified_dateutc": "2026-01-23T19:29:08.7758262+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": "2fec4936-74c7-49ab-8713-bb8277f96c4e",
"_parent_id": "c9b8839a-eb98-4f09-8816-415e469f26ac",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "7dd3ff58-e939-4605-bb57-baa6d6742a73",
"company_id": "4736fec0-58ab-4a87-8209-26fb7a204e00",
"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": "a722d4f2-d7ae-4cc0-9a83-4f6907171855",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "22b8d7e4-8f3b-426c-82b9-0bc04382ddc5",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "d711f8e2-4212-4715-bcad-b9192b14096f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3d216eca-3e95-4d14-a494-e971c764ed5a",
"company_code": "sample string 5",
"company": {
"id": "ea9ce09a-70e6-4b3b-80d9-6aa14f874c2c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-23T19:29:08.8383591+00:00",
"sales_territory_id": "3be1382f-4dfe-4a3d-b090-d59fa74c4efa",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ba15168a-c1f1-4f66-9a69-61d4a9656553",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "34bcba42-f99e-44cc-8d96-31e88d1a39f4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "84709755-b13d-4a49-a96e-656048216102",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6006754b-1057-4484-a66c-d9db1ba7b361",
"db_currency_id": "cf397b54-9315-4bbe-b986-c90d40ec0d58",
"db_language_id": "6548d326-d857-489c-8106-35c1ea8c66d4",
"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-01-23T19:29:08.8383591+00:00"
},
"modified_dateutc": "2026-01-23T19:29:08.8383591+00:00"
},
"marketing_segment_id": "98e4c0be-d3df-44db-90f0-38c6dce418b8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "de009eee-1b6f-493b-8660-1659d7c67cf4",
"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": "ae53be0e-a17b-42f3-b7ba-1b9e2652547c",
"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": "f0eb4666-1240-4d13-a58f-cd4efa5ca11d",
"db_country_code": "sample string 28",
"feelist_id": "43af4d59-aace-4bc6-bafe-8c64dff3e1b5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d19c49f6-604a-4408-94d6-bdd97f918bff",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a6e4d959-dfae-4a8e-a4dc-a12a84f7d121",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-23T19:29:08.8383591+00:00",
"db_currency_id": "0a5554ab-9626-4c81-b2bf-ad10ab9a0282",
"db_currency_code": "sample string 10"
},
"company_type_id": "a65876e7-34bd-4478-8110-87309ba629d3",
"company_type_name": "sample string 32",
"company_type": {
"id": "dc4a7c9e-406c-41f0-8473-42d8064f804b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "59bf8eb4-88a7-416a-97ad-1efdbf29639a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "470aa4e9-5b6b-4bf0-8dbd-90231df0a28f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dbe68fa1-278c-4908-8632-405de93d0b7f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "04af41e1-6084-4dc7-892f-2fec84cbfd32",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a79cc9d0-1b60-414c-bc8a-52234c100e8d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-23T19:29:08.8383591+00:00"
},
"company_sector_id": "9545b666-444b-4a0f-9340-c01a665ac4ed",
"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": "146ea013-cabd-4051-a60b-d80bd411617b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a40be499-33a1-454f-a8e6-0c01ae9604fc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a92943f3-9ab0-4aa3-95d2-f503f2bb56af",
"account_manager_user_code": "sample string 56",
"company_status_id": "6d359016-f07a-4bea-93fa-4e7579295a64",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-23T19:29:08.8383591+00:00",
"id2": 60
},
"db_language_id": "928cbe57-6c3a-429f-8d4a-3521c986aa26",
"db_language_code": "sample string 7",
"db_title_id": "021aaf9e-f157-45db-9467-d90ccde260cd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-23T19:29:08.8383591+00:00",
"create_date": "2026-01-23T19:29:08.8383591+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-01-23T19:29:08.8383591+00:00"
},
"modified_dateutc": "2026-01-23T19:29:08.8383591+00:00",
"id2": 22
}