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": "c6ba05f4-bad8-4bc8-8be5-afddc2a49b68",
"_parent_id": "ad1bd48a-2c07-4bf9-825a-941aefdbe529",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "26f2dccd-b852-4dc6-af9a-9e576dc9ea51",
"company_id": "708154af-e991-4089-998f-ce213b8d5ace",
"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": "4d582980-ac4d-4914-b83b-71e6fa3597e2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "17ea7d3a-7f2a-4cc8-99ba-3e3a2095127c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "8886a4f6-7dc0-4c13-903e-ea1fd7355c4a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c02ddf2f-daed-4cfb-91ba-8069c5326d84",
"company_code": "sample string 5",
"company": {
"id": "5f7b0180-8026-4947-a1c4-d2912ddedb86",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-25T07:46:06.7850556+00:00",
"sales_territory_id": "c2c05894-3f59-47f3-81a5-c65a7cfcfa2b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "755263f6-fd2f-48a4-a5b8-0d7637be281e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "96a17bc7-ab25-4c42-9708-4108288746c0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ace02814-d201-4b7e-a139-2682195c77df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2daa45a1-f74f-4b26-9508-3107aca4aa44",
"db_currency_id": "65d88e52-c5b1-41af-80ad-1dffe51455f8",
"db_language_id": "2e55be92-6f29-41a1-91cc-cde902b35185",
"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-25T07:46:06.7850556+00:00"
},
"modified_dateutc": "2026-07-25T07:46:06.7850556+00:00"
},
"marketing_segment_id": "0607c6b4-7207-4175-83e6-d346043b4e48",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9166af52-cc30-4299-9617-e45e6f0ab26f",
"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": "fcbb813e-7969-4740-872e-476576a21f68",
"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": "cfd4fcfe-7adb-44c4-b808-a23ec7247253",
"db_country_code": "sample string 28",
"feelist_id": "f2794d39-5560-4b70-b10b-32465a82d8e8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "821f6ee4-2a0c-4e4d-a4cc-b2be42fc9290",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c737969f-9a42-495d-ba6c-b9fc64e5dd0f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-25T07:46:06.8006857+00:00",
"db_currency_id": "16fe6e1f-ca88-4e08-90d1-2ae520daa283",
"db_currency_code": "sample string 10"
},
"company_type_id": "4a3054ed-de55-42ff-b23f-dcfc2a0f0ef0",
"company_type_name": "sample string 32",
"company_type": {
"id": "ec937108-e120-476d-894f-6740741bc1cd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4cc70a87-6901-48bd-8216-ffa86841daff",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c839b2ff-3e91-48f6-9143-210dfbf2a0ba",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bc5337c5-1eb9-4b42-96b7-eece65bb08c0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8f3399b1-1972-4163-962a-bcb30475bb4d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6e8fe98e-e581-441a-8bc4-c9bbc1bd24b5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-25T07:46:06.8006857+00:00"
},
"company_sector_id": "854284c9-e928-4b15-8bf7-9bca8376219a",
"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": "55046cc5-8f56-4a20-a19b-a4491af50bbd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "01ff3d44-a5f3-4dea-a689-93e898988764",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cf19201a-adc0-409e-a45c-03ec2b600fd2",
"account_manager_user_code": "sample string 56",
"company_status_id": "2da1c8c2-dbb5-4d60-83f6-88aaf1b9b435",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-25T07:46:06.8006857+00:00",
"id2": 60
},
"db_language_id": "c60ddc75-0543-4ba8-baa3-dc04b5c24a9c",
"db_language_code": "sample string 7",
"db_title_id": "118883c1-1ee0-4edd-b59b-ed70b10a2570",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-25T07:46:06.8006857+00:00",
"create_date": "2026-07-25T07:46:06.8006857+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-25T07:46:06.8006857+00:00"
},
"modified_dateutc": "2026-07-25T07:46:06.8006857+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": "8f2a24de-ff57-4231-a0c7-6d81d88a8eb4",
"_parent_id": "847410f2-71a1-4c17-806b-d36afc161b94",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "0261fe0b-03d8-4376-9d38-2427b41829f1",
"company_id": "9d514cee-473a-4715-81a8-cfbe65c9b9e4",
"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": "6a6c95f1-676e-44d4-bd9e-4e095c03d627",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "39bf390e-f4c0-4bd3-8cee-09fe867d3a6c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ff5e9aff-00d4-435e-bdd6-3c059cb5ee36",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d7b5f60a-dbe3-4c1a-aaa6-a8300f813c25",
"company_code": "sample string 5",
"company": {
"id": "1c6c86e8-c6e5-48cb-8aee-8e5b46b174bb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-25T07:46:06.8006857+00:00",
"sales_territory_id": "663b50f2-32ff-4718-88b3-26d2ae9e2e97",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8b01ba3d-bbaa-4f8a-aa8e-e22d4c6ec49b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cbbf06e0-caa7-4c42-b51b-b64441d56fb8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "47464141-26a7-4e5e-842b-40f6d3b904f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "114b1dce-d2b2-43c8-86c4-abab1e1493d8",
"db_currency_id": "5bc4db72-1eef-4b02-a37d-95bcaf0dd1e9",
"db_language_id": "897ac68c-8c21-4ab6-ab44-6656599de00f",
"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-25T07:46:06.8006857+00:00"
},
"modified_dateutc": "2026-07-25T07:46:06.8006857+00:00"
},
"marketing_segment_id": "113fe265-42da-484e-8aaf-649b5434ae1d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cb5035b3-8581-4241-9a65-ea449e33ea28",
"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": "838b6e85-ff41-4511-b811-30cf6705e39f",
"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": "9d848aa9-255b-4f65-a545-88ed9b26f6c9",
"db_country_code": "sample string 28",
"feelist_id": "eda83246-df7c-4574-bb23-2ac370ed714c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a1f981dc-018e-47f7-bf4c-083d2bfee624",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "720f0918-f253-4f31-8d08-e6787ece0c94",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-25T07:46:06.8006857+00:00",
"db_currency_id": "1c68c4eb-86a1-4a07-b916-afca5e9a9d19",
"db_currency_code": "sample string 10"
},
"company_type_id": "31ee4ae6-45b6-4fe2-8067-78b15f535bfd",
"company_type_name": "sample string 32",
"company_type": {
"id": "4a373f5e-82a9-40f6-987c-b84811e5206d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cf963f56-dd36-46ff-af14-22b6d89e519c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9b8ff73f-ca06-474e-ab4d-98ffc3b0018a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5973e9bc-ca03-4385-8417-efc60b652036",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6bc4248d-f8b0-43cf-8d6d-f23a8535806b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4c1eda8f-b37b-4772-a049-f073234f4447",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-25T07:46:06.8006857+00:00"
},
"company_sector_id": "ecf9b3bb-dea3-432d-9f0a-e8af429ea3f4",
"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": "1fcf4aa3-2ead-419c-ba82-bc84081edf1f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1b1df32a-bd3e-4b8d-8f57-d428bf11656b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "476871c8-14cc-433b-ab9e-631171b80182",
"account_manager_user_code": "sample string 56",
"company_status_id": "86089f41-2330-4481-819c-34dd0dc723dc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-25T07:46:06.8006857+00:00",
"id2": 60
},
"db_language_id": "0487038e-cc35-4529-ab39-b4d683d36774",
"db_language_code": "sample string 7",
"db_title_id": "0ea2c04b-b6ce-471e-86e4-add709b3806f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-25T07:46:06.8006857+00:00",
"create_date": "2026-07-25T07:46:06.8006857+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-25T07:46:06.8006857+00:00"
},
"modified_dateutc": "2026-07-25T07:46:06.8006857+00:00",
"id2": 22
}