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": "1ff485e0-50da-4a5f-b24b-881122f93a02",
"_parent_id": "8b20edd8-edd3-45d1-95e4-060fcbb1327d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "36a51f22-ac4d-447f-8856-0e61c2e17a2f",
"company_id": "6669f9c3-51bf-430c-9e53-ddb752c10ad2",
"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": "97226e54-9134-4ce9-8a3b-6547b0fa0adb",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ffda68e9-9745-4c37-93c2-2ebad0770bc1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "506a006d-a2e7-4c25-a7ef-d1934a90bc03",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9ba819a5-cbb5-468f-bd67-dffd41d6d138",
"company_code": "sample string 5",
"company": {
"id": "24a596a7-89f9-4755-bc75-1d4ee559a2cb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-09T18:57:51.9768831+00:00",
"sales_territory_id": "917e182b-8df7-46b1-a381-a2914620c5c1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f6368243-4a3e-457e-9574-0e7e3181d6e0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4c000c74-a1a1-4c2c-b06a-c4087b95b255",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "04213a9e-24af-4859-9088-1975cd350756",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15d21b25-0c9b-419e-a0d8-5a60729e5882",
"db_currency_id": "4111fc72-2fab-4d2e-8848-8360b38d255d",
"db_language_id": "6e6aa749-915e-4985-a16b-751881c8f56f",
"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-01-09T18:57:51.9768831+00:00"
},
"modified_dateutc": "2026-01-09T18:57:51.9768831+00:00"
},
"marketing_segment_id": "bbce37c0-dedd-498d-8be7-ab203be88ea8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bdc301c3-ab00-4a5c-ba60-b5d6d6291263",
"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": "0df60207-09c8-44ad-8533-be76c75751b5",
"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": "8e50442d-0fa9-4c39-a58c-5cb0002b2662",
"db_country_code": "sample string 28",
"feelist_id": "d92b2429-732a-4277-b69f-b4fc25258807",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d86abddb-b343-4743-8178-db3e0dd7a512",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8d182a96-6298-4d99-813a-4eb1219fe563",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-09T18:57:51.9768831+00:00",
"db_currency_id": "7a0b1387-29c9-4cb9-a997-2f3a6849a976",
"db_currency_code": "sample string 10"
},
"company_type_id": "20e4019a-d495-4867-9a61-f72cb3e15f8f",
"company_type_name": "sample string 32",
"company_type": {
"id": "047af1be-b71a-4e38-83b6-109bf8515ad1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6def0680-83bd-482e-9e78-b21885c2fa45",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e3ee0c15-6ebe-486b-9b0a-c66ddabf2fa1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8ee19f21-605f-4b61-b91a-12153126848e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "211285f0-1eca-475a-bfde-3496ac100dd6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8acb354d-a494-43d5-975c-afdd4c45440b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-09T18:57:51.9768831+00:00"
},
"company_sector_id": "5bf6e4ed-3c8b-469f-b11f-1684962336d7",
"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": "2de80304-15fa-4fe9-986e-3844f8c65445",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5aabe94b-b483-4d20-a14d-f41b3589febc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6ea1d4ed-a5a4-4320-bfff-f7cf77c9e43e",
"account_manager_user_code": "sample string 56",
"company_status_id": "5302cff6-7fcc-4238-9b21-d634a434d988",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-09T18:57:51.9768831+00:00",
"id2": 60
},
"db_language_id": "f9f21565-3723-40ec-8a92-c30be89e76f8",
"db_language_code": "sample string 7",
"db_title_id": "115ad206-d135-44bc-8052-6cca87ad06c2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-09T18:57:51.9768831+00:00",
"create_date": "2026-01-09T18:57:51.9768831+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-01-09T18:57:51.9768831+00:00"
},
"modified_dateutc": "2026-01-09T18:57:51.9768831+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": "b22b40ea-aed9-4056-9631-c6a63f135822",
"_parent_id": "44e74d57-5116-4b64-be73-b42dc42cab77",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "85188645-6c46-4b44-b2f3-0b9e33ff312c",
"company_id": "ed0d2bd3-71bd-45c7-bc49-465bfbbc7b9e",
"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": "ec2868d2-9932-46d2-a7ec-f45381802a92",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3864bbeb-468f-4416-828b-b3b75fb62895",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "1bee8ff0-071a-4bcc-b3d3-e78cc2fa830f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "487cab4f-9aa1-4e1b-a0c4-4762e8f3c9ec",
"company_code": "sample string 5",
"company": {
"id": "98d52879-0eff-4fcd-bfdc-16d785259b1e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-09T18:57:51.9768831+00:00",
"sales_territory_id": "a9bd7954-a8cd-4946-a7d9-a58cbd3ff42c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a6a63755-22ad-4eb3-87e0-aca3f95876cf",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c890842f-7216-42ab-8d2f-c730c65041ec",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7d78e734-185f-49f6-8e13-d4f2cd3fe0f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "98823b4e-b923-4cac-8810-d6c8526dfa53",
"db_currency_id": "96a14708-e8a4-44ec-93a8-a2540c3c6bfd",
"db_language_id": "952c81bf-a8e0-419a-abaa-15215c0da0fb",
"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-01-09T18:57:51.9768831+00:00"
},
"modified_dateutc": "2026-01-09T18:57:51.9768831+00:00"
},
"marketing_segment_id": "42ee0e4f-ead1-4a15-97ad-ef0b287e2233",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6f0f626c-176b-43eb-ae41-8817a54bac96",
"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": "2fc3bec1-035f-43c7-9110-636bc7b76b09",
"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": "96ba3238-c798-4051-9c93-e13ad17c1b17",
"db_country_code": "sample string 28",
"feelist_id": "361ca637-84cf-41cf-90ed-33ec6ae2b743",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "63ea338a-3e3f-42f7-987b-7f8589b265b5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0e6a81ab-c1bb-4643-b64a-2b4ac8bc4fcf",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-09T18:57:51.9768831+00:00",
"db_currency_id": "b6ebcaee-16f1-4265-b760-4badb81ec652",
"db_currency_code": "sample string 10"
},
"company_type_id": "da6cce2c-aace-4dab-b8cf-54258ac52d31",
"company_type_name": "sample string 32",
"company_type": {
"id": "a94c8c55-043a-4868-b480-f12bdcfeb28a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2465b84d-6795-4bd6-aa23-d2bcdc4850a2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "56ed8ac6-1326-4553-9a00-cc7023a8400f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8a7c04a0-78fd-498e-a6ac-f604e4589582",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "14f0c625-d09f-47b4-9c0b-b504e1339100",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4ecbf928-d813-4f02-8c64-b125418d5090",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-09T18:57:51.9768831+00:00"
},
"company_sector_id": "a87961ca-2c64-4fb6-80bb-253617b3d704",
"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": "9cb3c8b5-9650-4b6a-9fbd-2019276f3c25",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "dd26ee9e-c0f4-4f66-88ce-4988fbda0588",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2a7a690b-a723-4c66-8334-3b093a02973b",
"account_manager_user_code": "sample string 56",
"company_status_id": "247566f4-81b0-418d-bb70-2c7a7b781eef",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-09T18:57:51.9768831+00:00",
"id2": 60
},
"db_language_id": "25612738-4697-4d0b-8941-62654bc59fdf",
"db_language_code": "sample string 7",
"db_title_id": "29bf057c-ca30-4123-b34d-38e7174836d0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-09T18:57:51.9768831+00:00",
"create_date": "2026-01-09T18:57:51.9768831+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-01-09T18:57:51.9768831+00:00"
},
"modified_dateutc": "2026-01-09T18:57:51.9768831+00:00",
"id2": 22
}