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": "6f1388aa-0a06-4662-beb6-587bc8234df0",
"_parent_id": "a7fd9dde-97cf-4b2a-8ade-37ee9356f457",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "24b68839-b743-47d6-978d-41760fea8c35",
"company_id": "21c044fb-0306-4607-9b61-53882dc83835",
"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": "c26147d0-c0b3-42d7-be0e-7317dd8294d2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "acc1acfb-5107-4b62-92c9-507fb472f889",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4572a6ad-2ad9-48d3-a58f-66c4718ea06f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0f81b068-cfc3-4875-8f4b-efad768e54f1",
"company_code": "sample string 5",
"company": {
"id": "517a843f-c34f-41cd-8ef0-bae170d89844",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-02T03:48:53.4049097+00:00",
"sales_territory_id": "e223fbd0-33d1-4966-a758-d3fab55e3fe0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "84446a7d-3c4e-4fd3-9f9c-c635d1001837",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4859b291-bb88-4729-83a0-b05130308f05",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0458e517-0661-462a-8395-8e7c8499a8ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47fa0e9f-6a6b-4fb0-8730-a6cb4f5b00b9",
"db_currency_id": "979443e9-8f07-4f9f-9837-89172e29c2f2",
"db_language_id": "4a022387-2f1b-408d-a1d8-751b6f94a66a",
"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-06-02T03:48:53.4049097+00:00"
},
"modified_dateutc": "2026-06-02T03:48:53.4049097+00:00"
},
"marketing_segment_id": "86a38b67-a3aa-44cc-8e1a-e5af544b9370",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "91dc4b4d-3179-41b8-ae4c-296b806ac7e0",
"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": "f8f6369d-7e74-4813-bc43-3518e16ae95d",
"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": "82d173ec-f67b-4b65-b4ac-be6e8e301306",
"db_country_code": "sample string 28",
"feelist_id": "2b94c353-efdb-4cbb-ba4e-9229911c27e7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3b08dfae-43d8-40c7-bc55-d19f44a87e79",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c8a5858c-0eec-484d-aeb2-13d1892e4ab4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-02T03:48:53.4049097+00:00",
"db_currency_id": "9f955c19-73f1-4110-a586-5439472bcc31",
"db_currency_code": "sample string 10"
},
"company_type_id": "d3ab89ff-c831-4d34-a68f-a0c76d44b67b",
"company_type_name": "sample string 32",
"company_type": {
"id": "71d77e71-6e7e-4394-82c2-bc6db226b594",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d86c60fa-b914-4502-9a49-984132cf87d0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "98d50c65-291a-4a6e-b4ce-eb8ba5319311",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bd022059-fb1c-4954-824b-b21dd5422e4a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1507fc69-db09-4d49-8ed4-a83ad7e0a7e8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3c040d40-845e-4c68-9f1f-5fa7b963e576",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-02T03:48:53.4049097+00:00"
},
"company_sector_id": "f231620f-bb4e-4eef-bc10-be7a11ec857e",
"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": "4a0130f8-8c1d-483e-957f-e6a13d2ed17b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "934e35bd-4727-42ba-98e6-d6c6f984fc60",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0ed49c87-7b8f-4c9d-9cc2-8b0047fa3009",
"account_manager_user_code": "sample string 56",
"company_status_id": "9ab3d1c7-2fd1-4685-917a-7af6493e70d8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-02T03:48:53.4049097+00:00",
"id2": 60
},
"db_language_id": "660409ef-7895-4c44-bf5b-d50376693797",
"db_language_code": "sample string 7",
"db_title_id": "9daabca5-c0e0-4655-9bd6-d78ee4d6600b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-02T03:48:53.4049097+00:00",
"create_date": "2026-06-02T03:48:53.4049097+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-06-02T03:48:53.4049097+00:00"
},
"modified_dateutc": "2026-06-02T03:48:53.4049097+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": "f5ae1694-4906-40fd-8430-20c9cb2a2844",
"_parent_id": "58514fe3-46a9-4b1f-8ecb-6bd5d4ae46fe",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9909136f-20c6-490c-ba57-a4addf919c91",
"company_id": "f71ae262-83d1-47fa-bf13-7e78ba9e2f3e",
"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": "62beeaa7-6658-487d-bfe4-9527a2e8c874",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e0213301-3b49-40a0-b7f5-ae4c921ec7aa",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2bb3df3c-e14a-4564-97d3-7d1de4f48e38",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "52d6b869-d9ab-4641-ba36-535aba46b3b2",
"company_code": "sample string 5",
"company": {
"id": "fe78171c-f50e-4c43-b98e-ff77a99d7818",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-02T03:48:53.4049097+00:00",
"sales_territory_id": "dd1ec834-c37a-4760-bbe4-c29c722a6320",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "522483c7-eae6-4b8e-98c8-9cd0cc702278",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3f2fd612-7d51-4b41-99ba-852914d4c99e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "35c2a36a-05ed-48a4-9382-50e270448d9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b3b397d-b490-4ca5-b46d-65d38fef0220",
"db_currency_id": "b43b99bd-43d8-4068-bf69-c9744286230d",
"db_language_id": "5790c755-b73d-41f9-81dc-107fbfb0b4a9",
"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-06-02T03:48:53.4049097+00:00"
},
"modified_dateutc": "2026-06-02T03:48:53.4049097+00:00"
},
"marketing_segment_id": "26456e9a-c18b-484e-9184-c5c01c42ed9a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e694d773-f876-4f5c-9a39-500dc115ec8a",
"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": "fe6cd34d-7b9c-4aa6-9bc1-7437cca40570",
"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": "5e6cbd90-8ed4-43f2-af5b-133305c21edd",
"db_country_code": "sample string 28",
"feelist_id": "f9a90635-9965-4594-95db-e7e3cabda8c0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a9c4dd61-4603-41f3-83da-ba741ec0dc06",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a8f2b39e-9928-4818-9a2b-55e8dd22f8c5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-02T03:48:53.4049097+00:00",
"db_currency_id": "2c4aa933-7161-4cd0-bd23-ba01d4c2d09a",
"db_currency_code": "sample string 10"
},
"company_type_id": "4f417c2a-b7fc-4d16-ad13-9a6a8a634357",
"company_type_name": "sample string 32",
"company_type": {
"id": "0fe2c8da-f30a-46eb-86bf-88bad4019175",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3f80f259-771a-4dfa-92d9-0f47ed00b0e0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6ebeac8b-7fa2-410b-8aa0-7db888fd5e7b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c1cc6669-07ea-4540-8aed-3fb173370579",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "df174c94-5e30-4dce-bbe6-0208a7f33f8e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8adaf7e1-6d13-4573-8172-4c7fecf1f8c0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-02T03:48:53.4049097+00:00"
},
"company_sector_id": "aee6b046-a8b0-4ab0-9c74-cd2d6f5c0db3",
"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": "30d9986d-13af-4dcc-86f6-6b77ef5c7cbd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2319a8db-050a-4f88-83a7-ce782199f788",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "19ad3a37-d816-40cc-9147-efca7927c6ec",
"account_manager_user_code": "sample string 56",
"company_status_id": "61c013f9-00ba-4818-b4d6-0f4a0107c842",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-02T03:48:53.4049097+00:00",
"id2": 60
},
"db_language_id": "d76c2aaf-5ac9-4043-8e18-13ac3f8594a2",
"db_language_code": "sample string 7",
"db_title_id": "6d391552-3ca7-46aa-bf7e-a1ed98d563f9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-02T03:48:53.4049097+00:00",
"create_date": "2026-06-02T03:48:53.4049097+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-06-02T03:48:53.4049097+00:00"
},
"modified_dateutc": "2026-06-02T03:48:53.4049097+00:00",
"id2": 22
}