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": "6e7427d4-99df-4bfe-ab1d-83523accbbeb",
"_parent_id": "fb7400a9-572d-4491-a99e-73aacd1e87de",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6a32acfa-638f-4019-8f2d-45d9793f1c61",
"company_id": "b905bc3a-cc2e-4668-8125-a5281616a901",
"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": "3c38f2b8-89bf-4e6c-a983-0ca40eb850db",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "1df8cc42-168f-4cd6-8a77-d724843c7882",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "828ed7bc-951b-4bd6-85af-b298c1f4f7f9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ab81d1bb-8b59-473d-9797-6d61e2ecb765",
"company_code": "sample string 5",
"company": {
"id": "ca4e4ce0-0475-49dc-a910-de3c93d5d8dd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-15T11:06:00.9869502+00:00",
"sales_territory_id": "219df26a-684d-435c-868a-b440c97bb7c2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f33b0a3c-8634-4447-805b-7d106e7f5d1d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "28455088-bf82-4502-a189-37617e8f2bf5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "63d0a836-e0d4-493b-914c-70cb9b748ef6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb42b44f-7e25-4dde-888c-96efd9eb32ee",
"db_currency_id": "ed8bbbae-b405-4374-adfb-82ef06575aa5",
"db_language_id": "80a9ca17-e985-46b2-a7b3-605a24a0a5d1",
"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-05-15T11:06:00.9869502+00:00"
},
"modified_dateutc": "2026-05-15T11:06:00.9869502+00:00"
},
"marketing_segment_id": "278b976c-9082-4e9d-918b-4444cc72b63e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "579fc431-c214-4754-a348-acca417a857e",
"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": "eba1362f-1154-463c-b6c6-b5a2047c2ce3",
"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": "d91c76c8-a90a-40c5-908f-245bba957c76",
"db_country_code": "sample string 28",
"feelist_id": "ce4048ea-1cf4-4e7c-803e-94a70f052b44",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "28ba00be-ba1d-4d8c-b6f2-f5db5ad659e8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9f1b4f94-9de7-4743-b919-3e901b8d2c1a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-15T11:06:00.9869502+00:00",
"db_currency_id": "4eb004aa-08a6-49a7-98eb-09088a7ac3da",
"db_currency_code": "sample string 10"
},
"company_type_id": "5cda1494-52a8-4867-a113-3c18615598bd",
"company_type_name": "sample string 32",
"company_type": {
"id": "12646a9b-28fd-4ed5-9b28-46ad4bbff903",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f20081d7-6b87-4128-b8f0-38a3d3704eb4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "987f0bf2-029d-4fbe-8a23-7779d27c360e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d08e9c18-b965-41ce-9dcc-e645bfee86a3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6c163fe0-e729-42dc-b541-b576d35d0997",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fe44d21b-eaa0-45b2-836f-180951dc5aec",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-15T11:06:00.9869502+00:00"
},
"company_sector_id": "e34c76b6-7de7-4f1e-92e1-71fd9f59cb47",
"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": "aa6e9422-b2c7-4ff7-9211-82926b0a3b9a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f0bb717d-2e97-4b9d-8755-b2aea68bf8eb",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b5dea0cb-276b-4085-8418-38772ac12d5a",
"account_manager_user_code": "sample string 56",
"company_status_id": "a3115764-3ed2-4244-abd3-d415579dea67",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-15T11:06:00.9869502+00:00",
"id2": 60
},
"db_language_id": "2e769445-bd64-4160-aae6-a6ece49c9762",
"db_language_code": "sample string 7",
"db_title_id": "ec35dca4-9370-4e79-a7be-9972330fee8f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-15T11:06:00.9869502+00:00",
"create_date": "2026-05-15T11:06:00.9869502+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-05-15T11:06:00.9869502+00:00"
},
"modified_dateutc": "2026-05-15T11:06:00.9869502+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": "9ecc1ad8-f91d-4dd5-b43c-54025ed8e54e",
"_parent_id": "28f8dbc6-aab4-49d3-a242-481bddfa6a10",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "fe61a922-8dbe-4a43-b8e5-60d5ee7fd07d",
"company_id": "abef58fa-3c68-4319-896d-636c7059c1b0",
"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": "7e4505d1-cca3-4bbf-be9f-da1c16523186",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "5ed82aa1-d8d2-4c7d-b41e-5d9f515a72bd",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4254f4c9-6536-47fc-8ef7-4c0c74099e5a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "360768f5-dc55-4074-894d-5c9cd39e9c5d",
"company_code": "sample string 5",
"company": {
"id": "01281772-b3fa-400d-a76c-c0d38f73e741",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-15T11:06:01.0025748+00:00",
"sales_territory_id": "cb182baf-ced3-4274-afad-d3cdc7f74c96",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8f4bb33f-ae11-4a16-a688-7e0cb1a7676c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "850be7b6-ebcb-496d-bd4d-b328d8f3b256",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "16cac6f0-ba01-4e6f-87aa-b60f2648de7e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2bceca8c-955b-41c4-b664-d610042dfc0e",
"db_currency_id": "56269f79-f650-413f-be57-4d43bcce0826",
"db_language_id": "300b2e50-d097-4623-bb73-27c8b05b0a9a",
"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-05-15T11:06:01.0025748+00:00"
},
"modified_dateutc": "2026-05-15T11:06:01.0025748+00:00"
},
"marketing_segment_id": "cd5d1822-904b-49c2-b029-1adaea3f436e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "39eb24a3-9bae-4e52-b4ec-b8547900caa5",
"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": "d7d3e2f3-2251-406f-9085-112303d73921",
"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": "fced1967-ba4c-44eb-8491-1d6b4a671aa3",
"db_country_code": "sample string 28",
"feelist_id": "a843937c-c206-45e0-9b9a-46cc132ed7d9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "440c483d-4b62-49f7-aa3b-134fbf5121ac",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c5f9755d-1315-4068-b6c6-2e63a832e3b3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-15T11:06:01.0025748+00:00",
"db_currency_id": "7fee9045-9790-4f22-87b1-69defa30d9e5",
"db_currency_code": "sample string 10"
},
"company_type_id": "942185f9-7f48-43dd-a229-06475bca792e",
"company_type_name": "sample string 32",
"company_type": {
"id": "2fc3ffed-4d54-4534-b568-a3aa69e1db42",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "91af7831-c59b-42c6-80d3-19875e236625",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d1bed563-2762-437d-9a9e-3b1aff8c09ed",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ebda59ca-d5cd-42b9-a0d0-c3661eb283f9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bc3f76a0-5541-4a95-9c2b-c3a82548f5bf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f9bd6fba-373f-4d01-8778-7f079ab2bdf4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-15T11:06:01.0025748+00:00"
},
"company_sector_id": "181e8e70-7054-4cc1-aae3-ff4ec8b403b3",
"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": "fd08f362-c320-405d-96b4-d3c1c69ea2bf",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9d25d092-06e5-4821-afb8-809d4f078b99",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f6b0cf69-ae30-432c-856d-e6e37d1432df",
"account_manager_user_code": "sample string 56",
"company_status_id": "7bd2daef-94b2-4255-a90e-b16ee2dc10cf",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-15T11:06:01.0025748+00:00",
"id2": 60
},
"db_language_id": "18a32821-b266-4da1-92a1-8602cab45213",
"db_language_code": "sample string 7",
"db_title_id": "0ee662da-bc84-4ffd-9161-a68d6cfa6f2b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-15T11:06:01.0025748+00:00",
"create_date": "2026-05-15T11:06:01.0025748+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-05-15T11:06:01.0025748+00:00"
},
"modified_dateutc": "2026-05-15T11:06:01.0025748+00:00",
"id2": 22
}