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": "9dc02c82-18c8-43d7-adb1-2bcd32ce5353",
"_parent_id": "336a337b-edac-4391-832f-6d041cec0419",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "59bc04be-1952-432d-8fd1-7f6ea63434c6",
"company_id": "ed5c77ea-96b8-4718-9f21-2c47dd7f6cdc",
"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": "9bdc7cf0-1727-4d6a-8302-e10f00c00e9b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "7d5a3748-27d4-4da4-a557-f2dd6c519fd0",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "b0aabbdb-ce9a-4585-9c85-86586941b87f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cc96a044-e87d-4622-85a0-d86e84ecc2d3",
"company_code": "sample string 5",
"company": {
"id": "de2187ef-d4c6-4622-96d9-9960534ab257",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-22T09:53:40.0440814+00:00",
"sales_territory_id": "6b7d2a00-ab89-4d4e-bfad-be553c6d4aed",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7400bbd9-1e57-4d1e-add7-0bb5b8778f99",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bcde64ad-99dd-4f92-9a9c-39d4ede3be22",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "62eeae69-770e-4956-8795-e5a4552ead99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a98e138-9cbd-4d97-a43b-4f49fd17fa6c",
"db_currency_id": "8337359c-d7d8-44e7-acfd-49b23dde7369",
"db_language_id": "4abe0340-f08e-406b-8ddc-7f406b42bfc5",
"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-09-22T09:53:40.0440814+00:00"
},
"modified_dateutc": "2026-09-22T09:53:40.0440814+00:00"
},
"marketing_segment_id": "d596eb74-f04c-4e14-a0f4-c152c3ecf5e2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4e0cbf9b-aa56-4689-a393-fe5e22e00944",
"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": "1d6aa51c-8e52-4790-bda7-f12414bccd84",
"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": "46ce652a-e320-4c52-b9fb-5d14d9246157",
"db_country_code": "sample string 28",
"feelist_id": "c2c377d7-0684-4afb-9b9e-3b85dfd876f6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "94afb285-bd01-4b98-92ce-1aeee2edb793",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ab243114-0917-4b90-ad7a-db870e85ad6f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-22T09:53:40.0440814+00:00",
"db_currency_id": "d02c6961-b12b-43fd-9c5a-ecfc7852be00",
"db_currency_code": "sample string 10"
},
"company_type_id": "2a17c3d7-c744-4185-8897-9e1a4b0a9a0c",
"company_type_name": "sample string 32",
"company_type": {
"id": "abbf9829-5b6f-4239-8cd1-957be77f4371",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0dfbec19-8d7d-442d-9e65-64ef11589d85",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4667293f-4fbf-4599-a77f-3b6d3f6b4378",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d88d2b37-111d-4e0f-b1fc-0fc80fbf180c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "64d9c17d-c7ce-4621-93f2-0841114f5235",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "eba8a0fe-f4aa-4723-927d-fba44a347039",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-22T09:53:40.0440814+00:00"
},
"company_sector_id": "f835f262-b1b7-4ef3-ae8f-934f0410d2b1",
"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": "95c01604-b449-40d2-972d-2506b77f568d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "acb9360f-cdec-4509-9280-a7de2871bffc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a5b3348d-7608-4cc2-b90e-b5a744fd2db0",
"account_manager_user_code": "sample string 56",
"company_status_id": "abf1784d-ac76-4bdc-b58f-1ac8bec6a0b4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-22T09:53:40.0440814+00:00",
"id2": 60
},
"db_language_id": "8e9700c1-ae8c-4d85-a5ba-e5a9c50dd92a",
"db_language_code": "sample string 7",
"db_title_id": "b05509f5-1299-4477-82fd-8729793c6102",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-22T09:53:40.0440814+00:00",
"create_date": "2026-09-22T09:53:40.0440814+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-09-22T09:53:40.0440814+00:00"
},
"modified_dateutc": "2026-09-22T09:53:40.0440814+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": "df5f385c-55fd-479b-a29f-96c7fff711c6",
"_parent_id": "88024f73-50d0-4910-8944-a271c848e22f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ea055330-ae13-49fa-a130-8f4811df5400",
"company_id": "c27be25d-5bc9-407a-b0d0-eed2a1b53297",
"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": "306082cc-6806-403a-ab82-88eb7f487b47",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6753fe40-0e40-42af-98db-26a503def216",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "25c848e0-dd62-4b0a-9f40-87ba5f3f0552",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cd33703c-c540-4789-8f0b-ed0277f9bd85",
"company_code": "sample string 5",
"company": {
"id": "73f9ec0d-c093-4a9a-964c-59f8896fc296",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-22T09:53:40.0440814+00:00",
"sales_territory_id": "a31bb935-9421-4621-aeb1-ebffa2e40080",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "823e5ead-8ce4-49db-856b-f58c203f6b8a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "576b93b6-dbb9-4c09-91b7-3c6b8364eac7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "90c397b8-0857-4a29-9e37-37424afebff0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2925c372-3b2b-4462-8621-c49c5dbcce48",
"db_currency_id": "32cc928a-e4fd-4346-87fd-4050469a9296",
"db_language_id": "0e5fee80-0780-4dec-b874-770d6e888dbc",
"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-09-22T09:53:40.0440814+00:00"
},
"modified_dateutc": "2026-09-22T09:53:40.0440814+00:00"
},
"marketing_segment_id": "690f4c70-5715-4c79-babc-5acb905c0728",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6ff9d00e-bb50-43b2-b167-fb587e3ecd5e",
"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": "f6c0c1b7-b201-4006-a452-c03557a92a86",
"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": "55bace1f-19d7-49a6-9845-43cd0153d282",
"db_country_code": "sample string 28",
"feelist_id": "7a2b81cb-6a0b-4a69-adbd-c14e7e47ce3c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5a27d1b9-aaaf-4f72-8f5d-a71e81afe7b4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5b0ef534-1069-4d66-8881-cb5fd96609f5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-22T09:53:40.0440814+00:00",
"db_currency_id": "9196fbf1-db33-4d33-8923-14f2299db112",
"db_currency_code": "sample string 10"
},
"company_type_id": "449cec37-7dc9-4159-878d-d139cea4022b",
"company_type_name": "sample string 32",
"company_type": {
"id": "0f822a18-e5f9-441b-add5-9f552e7d1d5c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f9278d81-7316-4563-917f-17c1231710da",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8b954b09-948e-4bcf-9be7-64aa102ba2ea",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6072238a-bef7-495e-9ec3-29fc28abb01b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d38e08b8-c6db-4050-bdee-162370d7daef",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7e108af3-9b6a-44a1-ac1e-fe40beb54bbd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-22T09:53:40.0440814+00:00"
},
"company_sector_id": "ec139d8c-7b4b-42ab-8c91-a2875012d816",
"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": "b02848e5-897b-475b-8e2b-386d48308ee0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f512303c-74a8-44a6-a26b-d1ce38950b77",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ce4724fa-ec10-467f-b609-2878a31e70de",
"account_manager_user_code": "sample string 56",
"company_status_id": "0a96586b-6a39-4400-83b3-63f621f35b53",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-22T09:53:40.0440814+00:00",
"id2": 60
},
"db_language_id": "9b2500ca-0123-464f-9d16-e8a589140b96",
"db_language_code": "sample string 7",
"db_title_id": "f11f3610-e479-468a-b2f7-713b2c29b34c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-22T09:53:40.0440814+00:00",
"create_date": "2026-09-22T09:53:40.0440814+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-09-22T09:53:40.0440814+00:00"
},
"modified_dateutc": "2026-09-22T09:53:40.0440814+00:00",
"id2": 22
}