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": "374b473e-e246-43a9-a77e-6ac4934c8654",
"_parent_id": "ee5a4478-3bd7-4bf8-aeb2-1010459b6fb8",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e626ab43-4385-4ac9-b9ee-a79b11af1010",
"company_id": "535a18b4-ed46-40e1-aab0-0318e9645fbf",
"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": "d8e36f3b-5472-4f85-a4db-7a7c2c1d178e",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "23df7bc9-617f-4b0d-a91b-0f4eb9d34dcf",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "d372a4af-79ba-49e0-8615-d66aa135bb59",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ae1698f6-5a95-4e9d-9282-c35307aa5838",
"company_code": "sample string 5",
"company": {
"id": "bb66d3d0-ee3e-461e-b18d-1c2f09496db8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-30T14:15:44.2311209+00:00",
"sales_territory_id": "542ed9c2-6e25-498e-aea3-923cc004d77f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e447ec4f-0050-46a3-a60c-8d86ce480e28",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bdfa118a-0ebb-49fc-8428-7587940d3b4e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ef04abe7-2adb-4a55-b847-b8500061e9f6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc33dd88-13fd-47b8-b83e-afc4d41b1ab7",
"db_currency_id": "3bf989f7-fa3f-4bf0-9acf-1ee8808af04b",
"db_language_id": "7b83c81d-4e66-4db8-bb1a-c57ccc9fe108",
"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-11-30T14:15:44.2311209+00:00"
},
"modified_dateutc": "2025-11-30T14:15:44.2311209+00:00"
},
"marketing_segment_id": "0b2a23ea-bbab-49a6-a242-7d1523e29109",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "df0b5c4f-370e-44fe-a57b-627e098e2305",
"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": "5b380f3e-c60e-4bde-ba09-fc234ddc4cae",
"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": "76c9456e-fb78-4da9-9364-408800e38eba",
"db_country_code": "sample string 28",
"feelist_id": "038e4bb0-5b31-4c00-b545-159f3541e8f8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9837dc35-d69c-4c8c-933b-090c7ac945d4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "22dc7587-0882-4179-ae2c-3081361965f5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-30T14:15:44.2311209+00:00",
"db_currency_id": "0f660735-56f0-4708-a71c-fce0256613ff",
"db_currency_code": "sample string 10"
},
"company_type_id": "1b516453-bcf8-4155-82c5-8289b590a1a4",
"company_type_name": "sample string 32",
"company_type": {
"id": "f10e76cb-ad7d-4a26-ab8b-c68e4efe1d65",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f0ddc29b-b86b-45bd-a96a-b9312852fb2e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "26770a2a-9165-43f7-a6e8-261054260f83",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fbc3e4ab-8c3c-449c-85c4-4e86a8d517e7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8a1562c5-876f-47cd-97d2-c25057d0e5a8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "751ba93f-0748-47a2-8bc1-271dcd24b739",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-30T14:15:44.2311209+00:00"
},
"company_sector_id": "2e94db54-d4dc-45a2-a8c9-0efab2b31401",
"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": "91ee9948-e917-4633-a35b-7ef233077461",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9db81c03-34ce-421c-a412-e3ce14baa8f5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "927d74aa-db85-416f-b793-bd031b353c93",
"account_manager_user_code": "sample string 56",
"company_status_id": "6cb75375-3692-4d4a-aa72-a98b726ca1c2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-30T14:15:44.2311209+00:00",
"id2": 60
},
"db_language_id": "20781676-4c1b-43b1-80fc-ba460f931fb1",
"db_language_code": "sample string 7",
"db_title_id": "72be325c-6d77-4d69-8ddb-6449c85ca3ae",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-30T14:15:44.2311209+00:00",
"create_date": "2025-11-30T14:15:44.2311209+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-11-30T14:15:44.2311209+00:00"
},
"modified_dateutc": "2025-11-30T14:15:44.2311209+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": "5c6d330a-d906-4ef0-817d-b9159301e9c9",
"_parent_id": "89473c15-8656-46f6-8abf-f3a6c3cd2cc0",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "dcf27761-e299-4ce5-8cae-369c0e65bb7d",
"company_id": "3e97c7cc-541a-4146-aaa2-5a6c67c36fd7",
"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": "d6ca941a-2e29-414b-b497-ca26d896bb0f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "36a1398d-9aa7-4e24-a827-1ff992139589",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e941b28c-77de-4207-a6cc-18184f439393",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0eb2e7c4-0b01-4703-a694-ed5d6b3300ee",
"company_code": "sample string 5",
"company": {
"id": "e6491352-ef35-4253-9bf7-193f07331d2a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-30T14:15:44.2311209+00:00",
"sales_territory_id": "44bef112-18a1-4ad6-9c2c-4efb504e1765",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "33ea3955-1df6-4a62-8d1b-54ab7d97c437",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "24daf83f-4e4d-4f10-a079-7ef1ff84c108",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "26618c50-c8cd-461c-80b1-eb16629ef9a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bed0d1c5-8ea7-4512-b51a-672d36902f8d",
"db_currency_id": "1383faa9-2a06-468e-bb33-0e4f2900b059",
"db_language_id": "6941f20d-63d1-4747-8590-67947db73540",
"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-11-30T14:15:44.2311209+00:00"
},
"modified_dateutc": "2025-11-30T14:15:44.2311209+00:00"
},
"marketing_segment_id": "119b8354-395f-47ca-ab26-b21d0768adc9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bd8fe51b-66f3-45e5-8f1e-81b9ccc9b745",
"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": "9f83feb5-7959-4a1a-87a4-59238fc14674",
"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": "948016a5-95e8-4b76-8229-da0a33de2fe5",
"db_country_code": "sample string 28",
"feelist_id": "85545f87-c20f-4089-a4fa-fb3aa2a4e4ba",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8c50ab11-f48a-4e3f-b7f1-a570b3744d6c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "14431ed6-2b7c-4b65-90d5-79fc75a7f9b9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-30T14:15:44.2311209+00:00",
"db_currency_id": "f054a8d3-0edf-4c4e-a277-3ad6d1616558",
"db_currency_code": "sample string 10"
},
"company_type_id": "38c81372-f3af-4682-803b-ce9517720047",
"company_type_name": "sample string 32",
"company_type": {
"id": "d10bf034-575d-473a-b54f-0495d9e10499",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "271ac9ab-4e36-4caa-b1de-115a11c81922",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9628b94c-0f90-4168-b658-de12929fc062",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e5bf40c6-4376-43f7-940f-d5bfe8cd1600",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "392bcc51-f118-4778-8b7c-63141f3412d4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d8debf6b-c91b-49d0-acc8-1549d5550398",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-30T14:15:44.2311209+00:00"
},
"company_sector_id": "693b3a82-65cb-40d1-9d15-5e2755d4b0b7",
"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": "46e14d13-3e29-4d59-b87b-467519300d7b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "07995341-9beb-476e-a228-80425faf3b51",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "86fb9e27-fc99-4c35-b5ec-3a60cca71322",
"account_manager_user_code": "sample string 56",
"company_status_id": "c0266c4f-815c-4f9a-a4a2-e9b57b469ba3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-30T14:15:44.2311209+00:00",
"id2": 60
},
"db_language_id": "99f72974-cec9-47a7-815f-d453bda1b5cb",
"db_language_code": "sample string 7",
"db_title_id": "c0394a12-d0ad-431f-a28b-e915f3e03f41",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-30T14:15:44.2311209+00:00",
"create_date": "2025-11-30T14:15:44.2311209+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-11-30T14:15:44.2311209+00:00"
},
"modified_dateutc": "2025-11-30T14:15:44.2311209+00:00",
"id2": 22
}