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": "0b3f28f1-3887-40ea-9040-728613038e7a",
"_parent_id": "f1a5cac9-c225-4b23-9856-2bb0cccafa25",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "11449111-bb4b-4dce-a818-1d3be11abe25",
"company_id": "bd5f6242-1222-4a81-83e2-a531e5bde46d",
"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": "4213f1f5-94af-40c4-8ad9-d3c08e43e744",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ca2af0bb-35fe-4f0f-8ba7-51378135297f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4c06762b-a137-4020-90bb-3ba8bcfe2bc9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cc65f71f-212a-422a-8db0-6a61cd3e8281",
"company_code": "sample string 5",
"company": {
"id": "8286d98f-2ed0-4085-a467-477d9f89e0c0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-21T11:14:07.4080115+00:00",
"sales_territory_id": "dbd8598a-ff4a-44f3-88c3-8e2dfe447085",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fffacd32-519f-476e-b771-acc23da7b3bf",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "11188f05-6cb7-40c9-88d5-a697332436c0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a61f7cb7-ea51-470e-84bd-1397c7965bec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb08b95f-4759-4dcd-8989-a7dd5eaf0af4",
"db_currency_id": "e874741e-59e7-472b-9266-97ceac2a44b4",
"db_language_id": "9ecafc51-0bee-4acb-8a5b-2ddde71ed3d3",
"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-06-21T11:14:07.4080115+00:00"
},
"modified_dateutc": "2025-06-21T11:14:07.4080115+00:00"
},
"marketing_segment_id": "46e0ccbf-a19c-4c25-a129-e66028e11286",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9b8a1643-82ee-4145-aa03-539bbe0745b6",
"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": "0a4216d1-660c-460b-86f7-b6573f6f3b71",
"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": "7a05d6e0-ab12-4aaa-b5fd-714b38a471d3",
"db_country_code": "sample string 28",
"feelist_id": "63d68219-b0b0-49e5-b71b-604c9be4cd9c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b5fb3981-2051-4d49-835f-7797ae3986fb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f4566c2b-1b1f-49f6-a1bd-88c379711de4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-21T11:14:07.4080115+00:00",
"db_currency_id": "366ceb16-6916-40c5-8bdb-634ed170f993",
"db_currency_code": "sample string 10"
},
"company_type_id": "4e9c0876-7a2b-4178-b252-095e42ff4422",
"company_type_name": "sample string 32",
"company_type": {
"id": "0b1eae0b-23de-4eae-ad06-52d8d6d635be",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b324aef3-ce02-4318-9271-48a04fc9e7fb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "dc13893d-65b2-446e-8a88-c6a43ebd2831",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e80db7b7-813e-47df-8e78-1004934f9d50",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ee4f97f0-85a1-4977-8379-481bcb671336",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f0bdbdd2-9ea7-4d02-a92e-c6590cb3a47f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-21T11:14:07.4080115+00:00"
},
"company_sector_id": "c1c54d17-b289-4c17-8fb1-16b276c82dc6",
"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": "8e4c93c7-42fe-4430-99bd-df7c39fdc307",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "07675773-ca71-4e53-979e-95404e7e5f75",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5270a51c-cb6f-42fe-90cf-8875ce3c4e94",
"account_manager_user_code": "sample string 56",
"company_status_id": "7c29f824-d0da-4a72-a061-fd77b292fec1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-21T11:14:07.4080115+00:00",
"id2": 60
},
"db_language_id": "17a20319-5937-43ee-813d-6a24048a1e64",
"db_language_code": "sample string 7",
"db_title_id": "9c701be6-59a1-4d4f-a12f-31b7168b548f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-21T11:14:07.4080115+00:00",
"create_date": "2025-06-21T11:14:07.4080115+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-06-21T11:14:07.4080115+00:00"
},
"modified_dateutc": "2025-06-21T11:14:07.4080115+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": "e1f690a4-71fc-4666-9c46-41229cbe00de",
"_parent_id": "72b73e62-7ce2-4aa0-9b89-65f5e6272984",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b91fe264-b2fa-4f7b-86f5-7a3e4246cbe3",
"company_id": "e2e17a3f-c8fa-4661-bb97-03ab084ee4ed",
"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": "2391f02f-f108-452f-96a5-a90fb20ffdfa",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "531824ba-9f11-4ac8-bfe7-e6b19e91caf1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e2138700-18cf-4ab8-9171-edc12478f718",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8b6d9e7e-97c1-4e93-9531-7168378f8768",
"company_code": "sample string 5",
"company": {
"id": "78b12140-2384-4462-8a6f-ba5c9208d689",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-21T11:14:07.4392623+00:00",
"sales_territory_id": "8ab9bb84-1ebc-4193-a38d-01c43c246e87",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7a473109-4342-4c3b-b0c2-c082722f9bc2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c35cf39d-a4a8-49c2-bebb-b072bcaf87e1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9a085678-8b0a-498d-b436-98709d5617db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6290e75d-395d-49e4-a84f-8e1d4d107ad0",
"db_currency_id": "baba6085-ad03-42c5-964e-96bcd7aa9d1d",
"db_language_id": "9fee7cfb-ad9a-435b-9332-27a3801796f7",
"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-06-21T11:14:07.4392623+00:00"
},
"modified_dateutc": "2025-06-21T11:14:07.4392623+00:00"
},
"marketing_segment_id": "12915dbd-a47c-422d-be49-c43203f050f5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4fd2379a-95b9-4019-863c-f5dc120c1805",
"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": "ad908645-f11d-4748-960b-14bbbb869fd7",
"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": "0c17a717-33e8-4f46-959e-c704422fdd76",
"db_country_code": "sample string 28",
"feelist_id": "556e7c72-c51e-4ab3-adfe-926dbe04b742",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f3c08a5a-bca4-472b-a3cf-dd364dce239e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "652fd87e-e31d-430c-8e16-4c4d0a1539db",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-21T11:14:07.4392623+00:00",
"db_currency_id": "6dbaeff9-f0f0-4431-926a-4926c2d3d5f7",
"db_currency_code": "sample string 10"
},
"company_type_id": "771d3b7a-27bb-4e64-8f32-a9d05e0c9c1c",
"company_type_name": "sample string 32",
"company_type": {
"id": "35b22675-e8ad-4806-accc-d26f45290c49",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0ff40b0d-ea9b-43cf-9894-b70e5fa798ea",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d38e2e58-2731-48f5-8666-f76952df0998",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e8095325-dc6a-4b9e-b672-c89f9b43b211",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f05a52dc-de00-4e13-aa18-1c4e5943e905",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "170665f6-1700-4224-97fe-177a2afc625c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-21T11:14:07.4392623+00:00"
},
"company_sector_id": "c71d0d58-a86d-469d-80b5-39ac8d2f6aa4",
"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": "2e7faa14-28a3-4fae-b0cd-efb70db99dad",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7099d5f0-bd53-4073-a0de-cdf04d41d348",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "03615939-468d-4e8b-b2c5-be22da14c715",
"account_manager_user_code": "sample string 56",
"company_status_id": "dd1b28a8-1fd3-4d45-9253-b38974b832a2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-21T11:14:07.4392623+00:00",
"id2": 60
},
"db_language_id": "235c831c-3e0e-44bb-87d4-c1b2bd119ad6",
"db_language_code": "sample string 7",
"db_title_id": "253f7e48-80c3-4e4e-b990-20503f24c161",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-21T11:14:07.4392623+00:00",
"create_date": "2025-06-21T11:14:07.4392623+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-06-21T11:14:07.4392623+00:00"
},
"modified_dateutc": "2025-06-21T11:14:07.4392623+00:00",
"id2": 22
}