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": "30a31cf7-f2cd-4e0e-848e-73fd3f74676a",
"_parent_id": "6790cc98-a210-4c21-8a34-282933340c47",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "737f8e8d-33e6-4a58-a624-d598d805153e",
"company_id": "8e359810-d93b-49ef-a1da-6918ecb1c4fe",
"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": "0f2e4e45-943e-4b5e-8e33-9930b5326fd4",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "161e23d9-6cbc-48fd-960f-5cee13630697",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3d8e0176-d8b8-42b1-99c4-c445ad0d4b81",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d07bf02d-0fbd-4f25-a6ab-d5ff4a6da348",
"company_code": "sample string 5",
"company": {
"id": "39b9ec47-ed9d-4cb0-b435-20b5fc2ebcd3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-27T07:09:58.3172694+00:00",
"sales_territory_id": "0de222a2-1db2-4766-9b10-884a5dd08510",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5d97646f-511e-47f2-8de9-a04c1e4d3e5e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e99e5b74-fb07-44b9-8eaf-fdc6bca3de14",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d52c8570-1c2b-4d36-ae89-7ad36a237aa2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "393a40e2-f9e3-4416-a797-cf5cf54ddd5b",
"db_currency_id": "01c53dbe-be87-46ad-8a26-3a9ef58e7432",
"db_language_id": "d242dd2a-34a7-456d-867a-429e68f5cc8e",
"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-27T07:09:58.3172694+00:00"
},
"modified_dateutc": "2025-11-27T07:09:58.3172694+00:00"
},
"marketing_segment_id": "cc2a0cfc-888a-4129-aea8-b265420b0a1b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d970df86-2cc3-4bd0-8bc2-7ae1875ac35b",
"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": "222a23d1-5169-44a3-89a0-218c7f0fed68",
"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": "058a5337-7bbe-4216-8eb2-654941c1a5d2",
"db_country_code": "sample string 28",
"feelist_id": "eacd384c-2914-4da3-a22b-df1d7e9cde3b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "22e6c963-1042-4f23-b2cb-94125904f024",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f626b129-8153-42b5-b678-9302f6846520",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-27T07:09:58.3172694+00:00",
"db_currency_id": "638f182a-a5fb-43ba-9346-7d13c3c6c214",
"db_currency_code": "sample string 10"
},
"company_type_id": "9a70ccfc-f718-4687-9e6c-58f20eb75a4b",
"company_type_name": "sample string 32",
"company_type": {
"id": "1d8a9819-8b31-4412-bca0-375876bfbd7d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "577247b2-50c0-4a71-9ce8-2efbecb65be9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "70719627-76e1-4fd1-8389-b788eb4a5a79",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "984a1082-a452-4e2d-842b-3e01c8c3fe95",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c200f8b2-926e-43b9-93b6-e29d1dcc03b7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fec249ac-fe5f-4030-b533-752577b9d5d6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-27T07:09:58.3172694+00:00"
},
"company_sector_id": "ce8f7825-88fb-4076-a6f2-87aba898d506",
"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": "d9e1580b-3e4c-4ffb-bcbb-dd7ecbcd3257",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bcae501a-938b-4f75-8e85-ad0b7ddc6b57",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c6ed5d8e-7146-4791-9fb5-0e5e1ff87a93",
"account_manager_user_code": "sample string 56",
"company_status_id": "1a34893b-f6d8-4707-aae5-db07273a0276",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-27T07:09:58.3328977+00:00",
"id2": 60
},
"db_language_id": "c12d267c-2220-4173-8d3c-c97536889a4b",
"db_language_code": "sample string 7",
"db_title_id": "8393eb46-63d8-4068-9639-d8a4300a113a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-27T07:09:58.3328977+00:00",
"create_date": "2025-11-27T07:09:58.3328977+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-27T07:09:58.3328977+00:00"
},
"modified_dateutc": "2025-11-27T07:09:58.3328977+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": "62989205-db39-457a-8bd2-18970d7a7fc7",
"_parent_id": "f51b7f1e-200d-48e0-9a26-f402a71b0fdd",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "91430d67-6f18-4fa9-8d62-6a67a0fbcf79",
"company_id": "bd34fdfb-53e7-4a0f-ad10-f59bdc6d39d5",
"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": "8d9f9198-76c0-492e-930e-1214df6d5b6a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "981aa564-1a02-45e5-ac58-7a42cf869fc3",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9dccd9e8-d381-433a-84a5-dfae7400d39b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cd1cc203-0bba-4f31-a5e9-dc00c8148ebd",
"company_code": "sample string 5",
"company": {
"id": "8e15435b-df97-4a82-9eea-fe7d7ff6706f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-27T07:09:58.4579508+00:00",
"sales_territory_id": "23dc7b86-856f-4f5a-a505-f767557d953b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "200795c6-8651-478d-b2f1-888120c96f7d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "aa449575-32f2-4813-89e8-a9f09d9670f7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "93cba188-2c38-47f1-9e76-669163830c84",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5134e9a5-b3b2-4b17-9e96-30378c165e03",
"db_currency_id": "e78f67c8-cede-43f5-9cfc-7dbc1c934b73",
"db_language_id": "1075dcd7-3db4-4a92-a9d5-5f1d0c0b0dd0",
"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-27T07:09:58.4579508+00:00"
},
"modified_dateutc": "2025-11-27T07:09:58.4579508+00:00"
},
"marketing_segment_id": "4c9e6d18-072b-4dbd-9d69-696ab5c705e6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1c4dce44-ba9d-4d33-ab23-602d70b607cb",
"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": "bb1b3ae6-8a25-4ab9-8f36-443eb857ad8c",
"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": "44e6b860-df3e-4e3b-a16e-353cf2ffdb42",
"db_country_code": "sample string 28",
"feelist_id": "c7c699eb-f738-43f2-bb9e-7c134f722eb8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "059cfb0c-fa45-4d6f-a881-6f8960c3cd53",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ee66f2c9-b3cf-4539-82e0-ebbc3aa68e91",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-27T07:09:58.4579508+00:00",
"db_currency_id": "d949a9c3-65bd-4bf7-b5a0-5da5bdb64dc2",
"db_currency_code": "sample string 10"
},
"company_type_id": "200a100c-8f29-4b84-961f-cf9c9994f4ac",
"company_type_name": "sample string 32",
"company_type": {
"id": "d34ec89b-4166-44a9-8003-d10c8157935d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1fd4dedb-2bf0-4809-b724-eeb578e33c8f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "eb96d910-bbbf-4e59-b4b3-2ec7ca957468",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6049f14d-16ad-40d0-b23e-cba32043fc44",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c420c91b-d08c-425c-8ef5-b61ce62ac5f0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "876b19ce-9f3c-47af-9070-18286689190e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-27T07:09:58.4579508+00:00"
},
"company_sector_id": "5ff01238-fe7a-4c1b-a31e-a3baaf75cd02",
"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": "b08cc53e-e648-4ac4-873f-75f336781564",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b1e601a6-1913-4204-9207-6f6a96c89361",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "142f034c-1c58-4723-8fe4-af4671af2555",
"account_manager_user_code": "sample string 56",
"company_status_id": "d5f41719-f806-46eb-b00d-8a36f9e91f3c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-27T07:09:58.4735197+00:00",
"id2": 60
},
"db_language_id": "53a1a043-9c99-4b80-8d83-378077c49d9f",
"db_language_code": "sample string 7",
"db_title_id": "eef4b6de-8be0-4e1b-93cf-92e8521a4339",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-27T07:09:58.4735197+00:00",
"create_date": "2025-11-27T07:09:58.4735197+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-27T07:09:58.4735197+00:00"
},
"modified_dateutc": "2025-11-27T07:09:58.4735197+00:00",
"id2": 22
}