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": "a1e706a1-0af3-4800-8afc-00ea02578b1f",
"_parent_id": "51762522-7c08-40cf-ba78-4516f818f34d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "86c8e0de-98f4-4764-995b-cc4cec9637d8",
"company_id": "42f14259-9c9f-4bfd-a81d-20a4f13f9ebc",
"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": "6c42ead4-0f6c-4b80-b678-f19840a18878",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b5fc77bd-5bfd-4c86-ac96-51a9b31443a6",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "647b01f2-37f1-4073-8a73-768ab0feaec8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d61d8270-a2bb-46a5-95c8-05e62f0893f1",
"company_code": "sample string 5",
"company": {
"id": "106b0775-a94f-489e-8c13-b7c04bc53b22",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-06T20:20:57.881598+00:00",
"sales_territory_id": "9c645617-0016-4107-ba7e-758197ad9997",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ee14f86a-6e46-4b9a-8136-a194bd482b04",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4c1a6358-f7c8-49ba-8bad-0335bc2d34d8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ec0d900d-d651-47c4-8a3f-c4ef1f235501",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3154b601-95ea-458b-a847-aecd4a1bd843",
"db_currency_id": "b6280b76-86a4-45c7-9dae-13082b249462",
"db_language_id": "f731273d-5d68-46c4-b8c7-12a17195de8c",
"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-07-06T20:20:57.881598+00:00"
},
"modified_dateutc": "2025-07-06T20:20:57.881598+00:00"
},
"marketing_segment_id": "4f8bd831-a7a7-4cde-af9a-afba237f73ea",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "46f1bb20-d654-4637-af8c-5062208c9fce",
"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": "8add1b47-2456-4322-84af-7908efca262c",
"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": "de00f3b3-84fb-417f-89bb-7a9e6ee2b34f",
"db_country_code": "sample string 28",
"feelist_id": "c5ee4cf2-13a1-4df0-b678-2dab8679d967",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c900a4a9-a83c-4c1b-ad2e-5f80f8b822bb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2aecfe3d-e70a-44ac-bde9-2c2bdb796769",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-06T20:20:57.881598+00:00",
"db_currency_id": "b920b6f7-db38-4c82-b08a-bfdca1fe8ca3",
"db_currency_code": "sample string 10"
},
"company_type_id": "4151445e-923d-41a7-913c-7f6a099bf5c9",
"company_type_name": "sample string 32",
"company_type": {
"id": "94d9ad38-1379-4500-9190-8c1e5fb513bf",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cffcd73e-5934-40ff-a1d7-ddcddb12abd7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "007f44d6-53fc-49ba-833f-6c849bfaabb8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fdc8df9d-7145-48d7-811b-a19b387cdae5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8f2e7f48-f3f1-44da-9d99-f60baee7b88e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "151d26de-f3eb-450b-ad74-3cf0be4ba23b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-06T20:20:57.881598+00:00"
},
"company_sector_id": "b907a702-0828-4349-aa2f-d941a97763c0",
"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": "ebd59140-bffd-452b-ae01-f7b36f59eaea",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fc31e41c-8aae-4448-9b61-7013e889d044",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "527bfbcb-1fb1-4dff-bca7-46a716fc16ed",
"account_manager_user_code": "sample string 56",
"company_status_id": "4b9e7091-17d2-4d81-a828-eadd5b0096c5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-06T20:20:57.881598+00:00",
"id2": 60
},
"db_language_id": "91aa2c3c-a370-46a5-8b2f-c26a682c042f",
"db_language_code": "sample string 7",
"db_title_id": "2ba3a405-818d-47d3-9ab0-c30b99a7a3c6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-06T20:20:57.881598+00:00",
"create_date": "2025-07-06T20:20:57.881598+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-07-06T20:20:57.881598+00:00"
},
"modified_dateutc": "2025-07-06T20:20:57.881598+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": "83a15f18-c26b-4b34-b600-7884063852e7",
"_parent_id": "123d7d3b-6c0d-4d13-9f79-ea9770a6cd26",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "bdb46e48-3534-46af-a3d9-a964b972d2a7",
"company_id": "69100641-5734-4545-a122-ea2210eaf9b4",
"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": "c7c578c7-2205-4175-8367-3a46c501e7b1",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "92ccc513-7f8b-4e9c-b5a8-db1a31a93b02",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ef633640-c14e-4c79-9d51-066fe435c541",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c7b626df-d830-4df2-b9b2-e7bbf112b529",
"company_code": "sample string 5",
"company": {
"id": "8042a843-dea3-4715-8465-4e0fd96e2571",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-06T20:20:57.881598+00:00",
"sales_territory_id": "b1875ad2-3afb-4761-960c-8b5ffc869131",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "696b7612-309c-4b50-b35a-73b8689bd95c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c07aa5a0-37d1-4ba3-9d4f-47d39cc3863b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "711b4bd8-934f-4aff-8641-24b6dd821aa3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ae078e04-d69e-46b1-8983-10349b98f953",
"db_currency_id": "132e4f6a-e647-43ab-87c3-6584661ab24b",
"db_language_id": "e69231c6-2d69-40f5-a993-be8c29249b5c",
"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-07-06T20:20:57.881598+00:00"
},
"modified_dateutc": "2025-07-06T20:20:57.881598+00:00"
},
"marketing_segment_id": "13516fd2-8283-4532-ad49-9b15dc4ccbbb",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d05a7f05-fd02-474e-b861-4d2527f99ac8",
"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": "3a3b4ace-a59c-4191-a23a-175cbae355a5",
"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": "b2829139-1a25-44ea-8912-abd301180c23",
"db_country_code": "sample string 28",
"feelist_id": "d9dce2d2-e57b-470f-994f-6a247ce69d30",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2e7226fc-85a9-4f21-8393-4a9bb39445ea",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e3f2b8d6-10e1-4e63-af5b-c6519abb2f0d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-06T20:20:57.881598+00:00",
"db_currency_id": "e32ed2af-8aa8-455f-b4b5-d5caa7798836",
"db_currency_code": "sample string 10"
},
"company_type_id": "25d72c74-837f-403b-a876-13f49ac6560a",
"company_type_name": "sample string 32",
"company_type": {
"id": "119213c9-a5a6-407f-8ca8-d8e781de8878",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "85468f5b-f412-4e5f-900c-4b5de12f4109",
"sales_organization_code": "sample string 5"
},
"db_language_id": "df639e66-1873-451c-957f-6e9f4b56e30e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7e6862de-aa28-451c-95b6-cb8a72a738df",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d1f0f5e8-3299-44a7-a3d3-465792f53af6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0497f63d-94b7-45ad-ac8f-305149dbd942",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-06T20:20:57.881598+00:00"
},
"company_sector_id": "edda4c14-d89c-4fcd-a440-df47e4b55009",
"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": "b557207e-b915-459b-8684-c9a7c24d43c4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "14856d58-7dd8-44c8-bfb7-14bd2ab20a77",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1fb7cc06-f86a-4332-89e0-7981500b201c",
"account_manager_user_code": "sample string 56",
"company_status_id": "71218fe4-10f3-40e5-be8f-66db166f9223",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-06T20:20:57.881598+00:00",
"id2": 60
},
"db_language_id": "5e19bf88-45ca-4a78-963a-b5304bcb561b",
"db_language_code": "sample string 7",
"db_title_id": "be6830cc-7fef-4fba-a23a-91f4f847f5cd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-06T20:20:57.881598+00:00",
"create_date": "2025-07-06T20:20:57.881598+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-07-06T20:20:57.881598+00:00"
},
"modified_dateutc": "2025-07-06T20:20:57.881598+00:00",
"id2": 22
}