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": "ded530eb-b01d-4c4f-9d0f-91e94824c11a",
"_parent_id": "37ac5bdb-556a-47b1-8d0b-662efba95a8d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "4ef642d1-0c09-4c74-ae6d-b03fc328af78",
"company_id": "3b749d83-cf9f-47a1-b202-99c1281fe01e",
"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": "f8a3f600-1b52-4546-86b2-62d2ae5b58d1",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3baf3ac1-8364-4eb7-b55a-1781d07d6892",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "18e5d902-705f-4dc6-b74e-85f3630b1d92",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "19d7e0d3-976e-472a-bcb3-7656577ca35e",
"company_code": "sample string 5",
"company": {
"id": "5931e031-00fb-480a-baf2-d56c8510025d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-08T00:50:50.891006+00:00",
"sales_territory_id": "b9af6d91-b09c-4e9c-9ed2-d9654a4c6ea6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "88409f9d-7fea-4d67-a32c-c7bbe7dd7354",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ed27216a-d584-4610-933a-4a8a51546994",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5568064e-f151-4389-9fea-fa37818194b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c4000a38-ed21-495f-aab2-66ccd71badc5",
"db_currency_id": "c9fa2edb-cc0d-414d-b816-778e01db3682",
"db_language_id": "f2452faf-c482-4717-873d-0fa767c4a9d5",
"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-10-08T00:50:50.891006+00:00"
},
"modified_dateutc": "2025-10-08T00:50:50.891006+00:00"
},
"marketing_segment_id": "cb911bb5-4a89-4899-8faa-b7bece79f8c4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "47b658ac-7e2c-4ee5-9129-e2ee87a8d9a6",
"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": "156e3b3b-969d-4cb5-9d8e-4c03924b1e5a",
"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": "ace172ef-13a6-4862-a695-d5337cd60cbc",
"db_country_code": "sample string 28",
"feelist_id": "1e36fa3a-5f9f-4753-b9ff-e2c43bc3daf9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e65fea2b-efff-475c-9119-864b35423c1a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9c4534e4-70d8-4b30-b9cc-97b908c07d66",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-08T00:50:50.891006+00:00",
"db_currency_id": "d7bad5e6-db97-49b9-9ce4-a58a4220418a",
"db_currency_code": "sample string 10"
},
"company_type_id": "114d54cb-8c83-49c9-8756-2c9866177118",
"company_type_name": "sample string 32",
"company_type": {
"id": "c8f26ee5-a332-4338-a149-7d318e07ebc8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "564329f9-2089-4ade-aa51-f35e73d79fe7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "08cfd14c-a1b2-450e-95a0-b23a625a5e59",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "50cee864-5c87-4b51-9541-5138b4026878",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8963c720-3511-4638-bec1-f963bdfd493f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "54421d57-ee74-4a71-b84b-12214c915f31",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-08T00:50:50.891006+00:00"
},
"company_sector_id": "62c46fce-9088-41c4-b2fd-49124cdb32b2",
"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": "ad83d531-0dfd-43f6-ad9d-3005a9eb7684",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c0706a33-2b98-4d77-8d70-82dc7e69d8be",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5b587bb7-0198-4996-8bfe-7d61e1f0b61c",
"account_manager_user_code": "sample string 56",
"company_status_id": "bf4016d1-4f4d-4bf3-a858-fb2e47a86391",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-08T00:50:50.891006+00:00",
"id2": 60
},
"db_language_id": "faa62e85-658f-44d3-91aa-f423e6d75f7d",
"db_language_code": "sample string 7",
"db_title_id": "ebd10b3f-6a67-4ff6-8d59-a61bd2894a35",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-08T00:50:50.891006+00:00",
"create_date": "2025-10-08T00:50:50.891006+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-10-08T00:50:50.891006+00:00"
},
"modified_dateutc": "2025-10-08T00:50:50.891006+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": "8503666b-2284-4ce3-b889-de19cdba6cd8",
"_parent_id": "a262cef7-7531-4174-be09-ec8e43315ba3",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "33eb50f9-7340-477e-982d-1c213410f77f",
"company_id": "4a03a292-1e9f-47a4-aa5b-b6f2daf3093d",
"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": "2593cb52-4398-4027-9294-4715be88edeb",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f5ace40e-b42b-4d3d-8612-a59eb689054c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "fa5c4212-1c2f-49e5-9d7c-54521a4fec86",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "38dbfd4f-c897-4253-9bc4-58acae2bbd12",
"company_code": "sample string 5",
"company": {
"id": "a791477a-6c19-4c75-855b-d6057f870a6e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-08T00:50:50.9066425+00:00",
"sales_territory_id": "c9efe3a5-a1f2-4398-a1b0-67162330e73b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "74f3cf3b-9aae-4fbf-b665-fb79159c7421",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "97d139d9-5d46-4bb9-be54-0266d0a419db",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eb76e121-53b5-449f-b821-8828afc17ef0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5f4c93c-ea87-4836-b3e3-c61609741c9f",
"db_currency_id": "2f8cbba6-8f01-4751-a770-6d8584029f3e",
"db_language_id": "890648ec-6b77-4510-b9ee-8ff104ee57ad",
"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-10-08T00:50:50.9066425+00:00"
},
"modified_dateutc": "2025-10-08T00:50:50.9066425+00:00"
},
"marketing_segment_id": "9b9e868a-c323-4e0d-b1ce-0fd9f0252c42",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0679c812-84fb-47b6-994b-2fe6d54a00a9",
"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": "5820c214-0baf-47ad-ab0e-e16c347ecb14",
"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": "081e92f4-475f-4c58-a3d6-6b44dcff5de1",
"db_country_code": "sample string 28",
"feelist_id": "1f9fa27e-c360-4b29-b2e0-a12e581714eb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "96b1c898-2c39-4bf4-b830-2508a82b4114",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e6fe6983-0ba7-4667-ae65-e3bf52e792ba",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-08T00:50:50.9066425+00:00",
"db_currency_id": "a38e2fe7-0e3a-45f8-89dd-0f5ce4b8fa31",
"db_currency_code": "sample string 10"
},
"company_type_id": "e471129a-2710-48ef-bb72-8adba20be173",
"company_type_name": "sample string 32",
"company_type": {
"id": "718cbca1-7acb-479c-a9ed-7ca7e534df53",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2ce95c01-ea63-4014-ae1d-caa1d4e3cb27",
"sales_organization_code": "sample string 5"
},
"db_language_id": "64f3e78f-aa8a-4f8c-ad35-f767f167aba1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c18872f3-31c5-40ed-9900-7f1016096afc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1577f0e2-a71a-43c2-8590-defb9bf773a7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f1ce2888-050a-41ff-84ab-04496deba93f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-08T00:50:50.9066425+00:00"
},
"company_sector_id": "b75a0988-5edf-45df-bbf6-1c058468c564",
"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": "0b909baf-33c9-4d0c-bd8c-0076c3809ad1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0b9e6f1b-e01b-4e87-958a-e45140fd003a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "493da84e-ecf5-487b-a9dd-ae22d1392de7",
"account_manager_user_code": "sample string 56",
"company_status_id": "b25de6f5-a637-47f2-a88b-56d6992b6c59",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-08T00:50:50.9066425+00:00",
"id2": 60
},
"db_language_id": "6906ad2d-c3e4-44c7-a1ac-3daf0ca91ddb",
"db_language_code": "sample string 7",
"db_title_id": "0fd3954a-e3a4-49a8-ada4-77f252626626",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-08T00:50:50.9066425+00:00",
"create_date": "2025-10-08T00:50:50.9066425+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-10-08T00:50:50.9066425+00:00"
},
"modified_dateutc": "2025-10-08T00:50:50.9066425+00:00",
"id2": 22
}