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": "23d20e78-427d-4897-a209-4b38fc2e4c52",
"_parent_id": "d06d046e-bab3-4f6f-ae1d-bc00eef0d282",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "5f5ee67d-9c9d-422d-8c33-54ab4ada5681",
"company_id": "f2917bd2-a294-4be1-88a8-8675f4c71327",
"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": "5b9d291e-64e0-439f-9cbe-aae662e4924b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "4b5829f8-e0a3-42c7-9a84-9ecb1e15fd44",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "babd7280-8cd2-464b-8072-ab51096cdc1a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8d1dd9e2-9928-4115-8a1e-2f8243e12e49",
"company_code": "sample string 5",
"company": {
"id": "cf916013-e83c-42f2-b73a-2184342db77a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-14T09:36:48.9281988+00:00",
"sales_territory_id": "c235ed56-c69c-483e-a726-447882574ee1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8d9d8a38-eadd-4fb5-aede-509afa637a76",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1db63e0b-5872-4c3e-baa0-8e782e6d1f0c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e7c2e989-9245-4b94-a0ef-d3cd2409b7ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4739100d-55a9-4e2e-91bb-f9cf5401cc85",
"db_currency_id": "033d4fd9-0b0d-400a-8843-c39c565b053c",
"db_language_id": "0a0d218b-1be5-4cfc-af31-472c34ad95b6",
"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-10-14T09:36:48.9281988+00:00"
},
"modified_dateutc": "2026-10-14T09:36:48.9281988+00:00"
},
"marketing_segment_id": "29841c74-f223-45a5-b517-9d19b53a94f4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "24a47446-d23c-4c06-ba7c-87485ac91ae4",
"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": "7df696fc-6645-414d-8926-feb66a4a222c",
"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": "51bdbf4f-bd91-4b80-8e51-77bb642e28f8",
"db_country_code": "sample string 28",
"feelist_id": "add07ad5-7d40-4d39-bee0-5a52aa60c2fa",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5a39d232-708b-48d3-9c41-e4fb101cee7f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "45514686-2c94-4b04-b8d7-c13015e48c11",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-14T09:36:48.9281988+00:00",
"db_currency_id": "458a2851-9c33-4619-845d-536f3fc7c4e2",
"db_currency_code": "sample string 10"
},
"company_type_id": "74a2ae0b-cc61-4a25-9d05-f14ac0a2680d",
"company_type_name": "sample string 32",
"company_type": {
"id": "9bef86b6-014c-453f-b8db-97a811980659",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9c28d424-e89e-4b09-8a98-66ce70b88103",
"sales_organization_code": "sample string 5"
},
"db_language_id": "dfb05260-a9ef-485e-851d-a0f2d5c34a07",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5956c027-8997-47a4-95d8-17efd82e764f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d9dc74a5-e033-4ea8-a993-e7f9cb1d4695",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9fa949a7-5227-4350-ad14-527bdf449905",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-14T09:36:48.9281988+00:00"
},
"company_sector_id": "174bc324-9dd2-4827-9f20-775ab9a4ad47",
"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": "3e0f29bb-3a87-446d-8e69-e3308880f704",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "34e5770f-44f4-435a-b7e8-0bcfcf848978",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6895cb27-c802-4213-9497-9136b1f32bf0",
"account_manager_user_code": "sample string 56",
"company_status_id": "4ead53da-3c11-438f-ad4c-ec1eed63d13d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-14T09:36:48.9281988+00:00",
"id2": 60
},
"db_language_id": "ce7c70ff-3e78-499f-8322-52fe7756bd2b",
"db_language_code": "sample string 7",
"db_title_id": "3a4a21ea-3d4c-4c7e-a00b-b2cad2b2708b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-14T09:36:48.9281988+00:00",
"create_date": "2026-10-14T09:36:48.9281988+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-10-14T09:36:48.9281988+00:00"
},
"modified_dateutc": "2026-10-14T09:36:48.9281988+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": "4bc37774-80ba-496b-9371-ace21bd422eb",
"_parent_id": "9f4ecc96-3ebc-4b26-92f6-4acb8c3a8e13",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "26df78a2-4e38-44a2-ad20-3f97da586164",
"company_id": "9668ff07-0823-46a0-aa79-70d65149c9a8",
"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": "ce90c406-ae68-41c0-b474-0b1ed186b96f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0bb395a5-bd7e-4334-8aca-076a2d51b23b",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9b1709ad-3f1a-4c1f-b8c0-1db87ec38f93",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3c8c965d-db08-4b88-b8cd-ce5931c270c6",
"company_code": "sample string 5",
"company": {
"id": "cf3e2bb0-4504-4691-aacb-8c0734076749",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-14T09:36:48.9429483+00:00",
"sales_territory_id": "51e680dd-29d8-40d0-8c52-cce20db6a780",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "565ea578-5c70-4dad-8703-415f21b1f6f4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fbbb3b54-5f4b-4979-9835-f3770ea4abe8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4e25149a-4c63-4a9a-af26-ede79a342069",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7d103b7-9ada-4f8c-8206-2f79f1efd169",
"db_currency_id": "7c16d5c7-30b5-404c-a14b-460d1f1ec065",
"db_language_id": "4bf25424-37bb-443c-8044-07242ce6322f",
"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-10-14T09:36:48.9429483+00:00"
},
"modified_dateutc": "2026-10-14T09:36:48.9429483+00:00"
},
"marketing_segment_id": "d313a84a-005e-4728-b4b0-83b3bf4cab67",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "29808a68-daa9-41c0-a69c-d6720af0b7f1",
"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": "35534a5b-2b48-4c8a-b54a-ab059fa763c3",
"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": "4a05c37f-cf83-4ade-bb4c-ae42ea3ec174",
"db_country_code": "sample string 28",
"feelist_id": "f211328c-00d1-42c2-84a0-335822dded2b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6ad2a74b-d572-429a-a428-c5655f9219ec",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1b53e38c-4709-48d9-a600-1a697e428bd1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-14T09:36:48.9429483+00:00",
"db_currency_id": "d5346760-eaef-4be1-8b9d-59a5781983b2",
"db_currency_code": "sample string 10"
},
"company_type_id": "931b5728-45b8-47e7-8795-ac627f2b0b17",
"company_type_name": "sample string 32",
"company_type": {
"id": "3535d5be-b6b3-471b-bea4-b8c1cdd6ef50",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "da464e0f-4914-48e5-b31f-22da108d70b2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "02c31914-9ab0-4416-ad95-06a1c810c161",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "68beaaad-34b4-42c4-b56f-e9f40a7d7862",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "19031383-207a-4f12-917b-568d4e7f0fa1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a7e2a068-c79b-4237-aefe-e5bb075b64d0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-14T09:36:48.9429483+00:00"
},
"company_sector_id": "ae2be058-b6b3-49e6-b439-e2c836af1a1f",
"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": "e22e173a-6b15-4379-b23e-96363081bc11",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4f5e5fe9-2e2a-47b0-b0e1-f455a9ac8c6f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "eb666430-a11e-4fc1-bf35-36a3e8ce34b9",
"account_manager_user_code": "sample string 56",
"company_status_id": "14427441-9da1-48ea-ad22-8d53055c68c6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-14T09:36:48.9429483+00:00",
"id2": 60
},
"db_language_id": "75b49ddd-36ed-4e16-9f24-6ea25dadc68b",
"db_language_code": "sample string 7",
"db_title_id": "c7259fa1-84bd-4d00-baaf-24fd0c8821c0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-14T09:36:48.9429483+00:00",
"create_date": "2026-10-14T09:36:48.9429483+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-10-14T09:36:48.9429483+00:00"
},
"modified_dateutc": "2026-10-14T09:36:48.9429483+00:00",
"id2": 22
}