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": "0fca433d-18cb-4563-b6d2-787ccb74350c",
"_parent_id": "c782acf6-b2e1-468a-b9fb-ff2c2864b427",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2b68cedc-dbaa-4264-8cc3-1718e39ced27",
"company_id": "fb472653-fffe-4d9a-9f4e-5b3ade0008c9",
"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": "2179f514-a5e7-4e77-ac65-76e9b62d3b1f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ed17f24f-6886-40c3-be38-76be6a8daafb",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e7b1afc2-44e9-4c1c-a9fa-a01ee885edb7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c674f9a2-ecd7-4603-95c5-ae0581510a2a",
"company_code": "sample string 5",
"company": {
"id": "f5b03228-5860-4432-8c89-e2da06d5e527",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-15T14:33:39.3565453+00:00",
"sales_territory_id": "ed0e3344-8409-448f-a5f8-a9b411f3898b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "82d37d15-6a7c-44b7-80ac-e03548bedc11",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2716d9d4-736d-455d-9cee-c0afbea28ae8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "10241cb7-86c5-4a20-a38b-e1204e13deb1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28eac270-454f-4d33-841a-7082815a4484",
"db_currency_id": "69acc457-f9b5-490c-95f8-65a64a1130d8",
"db_language_id": "d3a313fe-e7cb-47d7-8c97-57f33d298961",
"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-05-15T14:33:39.3565453+00:00"
},
"modified_dateutc": "2026-05-15T14:33:39.3565453+00:00"
},
"marketing_segment_id": "2e0ce4ad-1fb1-4c88-9444-8509acc14e25",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9a6cd85d-30ad-4c0b-aa10-75f36355f818",
"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": "b70fb639-262e-484e-9c16-12b8b3498064",
"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": "616bae5b-f962-406b-9139-8d273faa7890",
"db_country_code": "sample string 28",
"feelist_id": "00595b40-f377-4bb3-8933-9ec91237d2ad",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e02d1ddb-dddd-4d83-9f04-b111d309479a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4967eaa4-2d38-4e35-b0b1-69c137f2d9c4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-15T14:33:39.3565453+00:00",
"db_currency_id": "70b0a7d3-5c02-4dd3-bbe6-d161fe37b7e8",
"db_currency_code": "sample string 10"
},
"company_type_id": "c33c4ff9-07e6-4552-ab52-706328862b93",
"company_type_name": "sample string 32",
"company_type": {
"id": "49cd587e-9458-4725-a14a-b48addad7a62",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a67610fc-a15d-479e-95e1-f009711a0151",
"sales_organization_code": "sample string 5"
},
"db_language_id": "08e1c6ef-04fe-4cff-b75a-d34ba7d6bb60",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "39a27465-73bc-4174-af2b-70ecf7d36496",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "557ac77b-a507-46bc-bf74-e7700c00d2e7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "636ac91a-6969-4bee-8729-4b0b315d114d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-15T14:33:39.3565453+00:00"
},
"company_sector_id": "eb61d863-b108-45c9-baab-c09d1ecffed5",
"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": "432e88db-3bca-4cc5-bf21-178618c43915",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b6bfdb2c-1a0b-4022-a500-f8dd9bbf40e8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cf099cec-a5b3-4361-af11-3cf020a9b02c",
"account_manager_user_code": "sample string 56",
"company_status_id": "162f536b-47bd-4824-9710-8497e1a0fd4c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-15T14:33:39.3565453+00:00",
"id2": 60
},
"db_language_id": "589ab730-4ccf-4236-8f7d-45184ff6c6fa",
"db_language_code": "sample string 7",
"db_title_id": "446f9dfd-a6b8-4251-acbe-55b4026ef31b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-15T14:33:39.3565453+00:00",
"create_date": "2026-05-15T14:33:39.3565453+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-05-15T14:33:39.3565453+00:00"
},
"modified_dateutc": "2026-05-15T14:33:39.3565453+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": "3e7fb7aa-d4f3-48be-968b-73d7f04b824d",
"_parent_id": "7f70242f-d332-4bad-9cc7-48e20b586a46",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "074e8f74-3d38-4119-951e-673bf6b45503",
"company_id": "e827b9ea-f783-4881-bba1-c1df22c29544",
"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": "035be39a-5f3f-4739-9e64-dc47ede1d571",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3c97d52a-7905-43f5-84db-8afdfc10aaf0",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "1b0bc081-f325-4821-84f3-954ea24051f0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ccc6672d-a8be-4788-a347-708416374900",
"company_code": "sample string 5",
"company": {
"id": "bee0d1cc-d43d-4c5d-a0a5-fa40dbc068e2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-15T14:33:39.3565453+00:00",
"sales_territory_id": "0475c403-dd9f-4d3a-8c4b-88e03200a290",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5202cc57-df61-4194-8908-94916088a818",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4b63aa50-1aea-454b-a39a-aa5af3aee120",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e9c2655b-b6a0-4661-8109-73d2ed02c01e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7005c3c1-56d0-470a-bb0f-2839a9451d11",
"db_currency_id": "0e896d33-959b-41c5-a127-93d8d7dd8521",
"db_language_id": "facecaf9-8056-47bd-9a7d-051d7e3722fa",
"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-05-15T14:33:39.3565453+00:00"
},
"modified_dateutc": "2026-05-15T14:33:39.3565453+00:00"
},
"marketing_segment_id": "a8e1117e-9cb6-4a29-927d-bdfc34d76aab",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5e7782b5-169e-4978-a84a-8b22b76b600e",
"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": "181cdf37-1816-405b-b9b4-3b9fb07328bd",
"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": "3dd4c4c1-3270-4883-83b8-57ca585656f3",
"db_country_code": "sample string 28",
"feelist_id": "c5c26744-7e9d-4592-819a-4a41b4e64ccd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "653eb41c-f19a-455e-926e-b310b7a89004",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c75925f5-2bb3-465e-987c-cf3dc4f636f7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-15T14:33:39.3565453+00:00",
"db_currency_id": "1751e49e-f601-4c88-b976-631e873518f2",
"db_currency_code": "sample string 10"
},
"company_type_id": "d71ada29-25ae-4ee8-a9eb-d84632b62774",
"company_type_name": "sample string 32",
"company_type": {
"id": "30915f19-0ab7-4347-b878-8d27b41fb2c6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "88c74994-83dc-49b0-99ac-1e7332226cd1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "dd366d15-683b-4e47-bce6-f659068005e0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "99bde596-23f4-449b-bfa6-32211a324e5e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d7280609-3efb-447d-95de-19bb0f95ca07",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7f7c3e58-e2c2-4066-b180-13cc7181f382",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-15T14:33:39.3565453+00:00"
},
"company_sector_id": "3ab14152-14b9-4048-b413-fae41a31a85d",
"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": "9b8232db-ea56-4d65-b4f2-a5bffa4b564e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fff8b00a-dee4-4c2b-903f-2058ba52c73c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "eebc616a-e457-4370-a74f-70be40afb1e0",
"account_manager_user_code": "sample string 56",
"company_status_id": "fc899688-f800-4876-94d9-a4daaa7f5963",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-15T14:33:39.3565453+00:00",
"id2": 60
},
"db_language_id": "ad368683-f9ae-405c-962f-7492d38f869d",
"db_language_code": "sample string 7",
"db_title_id": "3a935539-994a-4150-a73a-a3b7c1fe8a20",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-15T14:33:39.3565453+00:00",
"create_date": "2026-05-15T14:33:39.3565453+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-05-15T14:33:39.3565453+00:00"
},
"modified_dateutc": "2026-05-15T14:33:39.3565453+00:00",
"id2": 22
}