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": "a3f92f77-49bf-4ce4-9e70-bfdc926ba046",
"_parent_id": "baf6b3bf-83ce-45b6-a2c8-91cbc949f9bd",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "63eae551-ca0a-4401-86ce-37cb395ee378",
"company_id": "78bbf3db-a2df-4664-942a-014c5f5cc06d",
"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": "92ae4ba0-5b86-488b-b1fb-bad3c3eb6793",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e0a01b6c-4714-41bf-82f8-0efc815f43c4",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2be6bccd-77dc-4324-b66c-84afe88fe9c0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7e0f54e7-97c2-42dc-bee4-78a0af1634d1",
"company_code": "sample string 5",
"company": {
"id": "97727cbf-5bd6-407b-8808-2a635a5f0c88",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-17T19:06:24.9067405+00:00",
"sales_territory_id": "6af55c0f-3890-4141-98e1-2d5ac1aea0b7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "eb3d7399-662d-4d5e-871e-ffeba32dbbc8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b33571e3-c2c4-4be9-afb3-9f6c1afb584d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d05b76a8-c189-4854-937e-7e7f75b76e75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8940c6ce-7f5f-445f-bed3-30eb42c6df3a",
"db_currency_id": "97db1a0a-2a48-4d83-b1f0-5bee70f690aa",
"db_language_id": "68ae9ac8-be7d-41b8-b6b8-4533f24ea807",
"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-07-17T19:06:24.9067405+00:00"
},
"modified_dateutc": "2026-07-17T19:06:24.9067405+00:00"
},
"marketing_segment_id": "25e1c742-9164-4a25-80f1-8570516b624e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "55164c23-7bc9-4140-aa72-c71f54b2c26d",
"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": "5a98955a-8a78-46a6-a131-6ea86be79bab",
"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": "e43ce389-e7eb-4ca0-a37b-a29f4f37d6e6",
"db_country_code": "sample string 28",
"feelist_id": "c5bf29dd-d0db-4934-aca5-2388d0715030",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2950007b-af05-4db2-9089-47aaf88f0a25",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f3545b15-0d02-452d-9d31-d0d59db260a7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-17T19:06:24.9067405+00:00",
"db_currency_id": "7c52e6c2-ad67-4d8b-8e97-7a441e210678",
"db_currency_code": "sample string 10"
},
"company_type_id": "a3642c26-7964-452d-a990-5ff73dc2babf",
"company_type_name": "sample string 32",
"company_type": {
"id": "24d1b55e-d550-44f7-b05e-b495bce8344a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9a73cde3-36ba-4a83-b194-6ddae90cfa88",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8fbe14d4-f26c-43c6-8db7-8aae787275db",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cd5ec504-a30f-4b75-96ba-4c4c84a019ac",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ecbd8689-fe3c-41c3-abc8-f88e49214e5b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1f10037b-b1ad-4235-85df-0642fa57e15d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-17T19:06:24.9067405+00:00"
},
"company_sector_id": "3dba5b56-6bca-4ae7-acd0-e0b49a22b5f7",
"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": "bfef8e1d-516a-4404-8b96-cf1f1fc86d0f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "27ae6734-fbe8-490a-89af-e61c1608fe4c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "14e1db43-5c99-4390-8bd7-99a5a9d4373c",
"account_manager_user_code": "sample string 56",
"company_status_id": "1546107e-254d-4dd3-b21c-5973ec600b98",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-17T19:06:24.9067405+00:00",
"id2": 60
},
"db_language_id": "ce099275-faab-4fa9-b4d5-394e122c10af",
"db_language_code": "sample string 7",
"db_title_id": "16cc15ec-640e-488d-bc66-af0ca06c917d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-17T19:06:24.9067405+00:00",
"create_date": "2026-07-17T19:06:24.9067405+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-07-17T19:06:24.9067405+00:00"
},
"modified_dateutc": "2026-07-17T19:06:24.9067405+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": "685eb6f5-0496-4131-b6f4-c0302e635582",
"_parent_id": "c59405bc-ffdb-41f1-9f9b-bdd4da89505e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "390e3b9c-ecb7-43f1-b885-38e92dcf395b",
"company_id": "05e7fb6c-0b1d-4486-b5be-c061bc418337",
"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": "1db7affa-f9c9-4cc6-a173-f1b273308460",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "4719a313-9441-4cb4-98c8-0475c7ad382a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4940299f-1866-417e-bc44-f4d1904bd07e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1e33154b-61bf-4055-924d-f054e2528969",
"company_code": "sample string 5",
"company": {
"id": "dd2250c3-d979-4202-9382-fd1e6db730e7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-17T19:06:24.9067405+00:00",
"sales_territory_id": "961e78bb-1c05-4f7c-9cf1-4d55380e3aad",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c21e026b-e151-4d48-a634-68b648b24fe4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "38d6dddc-e6bd-4c4c-9aea-4620e05cd87e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6518421d-2154-4bd8-af43-eed52fd83ead",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "133bea60-8bcb-4fd7-be12-a01349a58398",
"db_currency_id": "80eaee1b-3060-4db4-9d4b-9305360545a9",
"db_language_id": "f4893732-afe7-4041-a257-e59d1e6242dc",
"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-07-17T19:06:24.9067405+00:00"
},
"modified_dateutc": "2026-07-17T19:06:24.9067405+00:00"
},
"marketing_segment_id": "b5f8eeee-d99e-4b1b-b56d-4c1f87747f6f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "007f6d7b-66a6-4095-ab2b-3eafa35716b6",
"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": "21b4beda-1eaf-49cf-8459-c172406fc119",
"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": "b559fc10-ad8f-49ab-ac15-8c200b537784",
"db_country_code": "sample string 28",
"feelist_id": "3cf5bd98-fc25-4e3b-b928-76ab4c3cf3c0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1305cf43-3d02-4950-8839-6b9899d49677",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9b5e3038-f4f8-41ff-8d69-77c3fe75e13b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-17T19:06:24.9067405+00:00",
"db_currency_id": "31d8f9e8-bddb-4b31-8e43-5ce6ca27bc02",
"db_currency_code": "sample string 10"
},
"company_type_id": "1b499651-dad7-4a5b-b76c-f51821f602a8",
"company_type_name": "sample string 32",
"company_type": {
"id": "33078527-99e3-4393-a4b9-5220b5476029",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eefb41cd-ec4e-4318-ba96-b5b75f7ad962",
"sales_organization_code": "sample string 5"
},
"db_language_id": "53cce9b7-9568-4198-9f45-f5a94ae7fd00",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "64a073a0-62e7-4368-b1d8-e7da8ac5cdf9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f2f5e3d2-2987-4d74-91ec-e8745664d0f0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "89a2436e-2a1b-46e9-b7f1-cbacc1d3d1ef",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-17T19:06:24.9067405+00:00"
},
"company_sector_id": "67c1217d-e680-4e3b-9f12-4eb7ad6c57bc",
"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": "8719942d-1477-4666-9dc7-70fec0bff88d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0100231c-0c06-48aa-99fd-8186a7485236",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3e2299fd-261d-4f53-b356-da3d5d6c3b8c",
"account_manager_user_code": "sample string 56",
"company_status_id": "e86fd114-6d40-4b5f-9285-d38934ee19a4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-17T19:06:24.9067405+00:00",
"id2": 60
},
"db_language_id": "2e869ecd-6904-4595-89e2-9fdbfa4b2d83",
"db_language_code": "sample string 7",
"db_title_id": "77c41115-7f34-42a0-9617-7afd1e07e7f0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-17T19:06:24.9067405+00:00",
"create_date": "2026-07-17T19:06:24.9067405+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-07-17T19:06:24.9067405+00:00"
},
"modified_dateutc": "2026-07-17T19:06:24.9067405+00:00",
"id2": 22
}