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": "7f661400-0a0d-4567-bc56-6c6a1a8541df",
"_parent_id": "769da9a4-b845-4fcd-9ef9-bb5b866d9d3d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b7df8d54-03e1-4c95-962a-fc3c7d43f119",
"company_id": "7ee1103b-a592-422f-9db2-c771a6a90799",
"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": "fadc8b44-c00d-418f-b534-8b8066c34c52",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "dc966b93-129a-4800-ba20-96bb4285121d",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2af56324-eaf9-4a05-b359-e1a4471090af",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "48933c7b-233f-4972-bbb0-eb38de9fb422",
"company_code": "sample string 5",
"company": {
"id": "2a650318-c3eb-43de-ad7b-d371ac5a0838",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-10T05:39:20.4752699+00:00",
"sales_territory_id": "e19b6913-c2b7-41a8-bdf3-cd35ed4d53e8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3e094845-abc7-4c11-b473-c12406936afe",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "772d18bd-6219-4153-be5d-ba5ca1401810",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "78d747c1-9c97-4472-bed2-8bd1d664aeec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "32b90fff-2ff6-4e36-b58e-0731018f719e",
"db_currency_id": "7bcf0d12-7f85-4ea5-b3f7-6b04a3031bce",
"db_language_id": "033677ea-2713-4f41-81ad-e3400de8ee70",
"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-11-10T05:39:20.4752699+00:00"
},
"modified_dateutc": "2025-11-10T05:39:20.4752699+00:00"
},
"marketing_segment_id": "d18f9f02-1810-4db8-8f0e-8c0a600f4aec",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "74778abb-9706-4502-837f-95e040853d78",
"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": "31cd2c8d-fcb0-4196-b0f5-94ec95d38a17",
"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": "535f4b71-8e47-4fd0-b189-15ae9898b86f",
"db_country_code": "sample string 28",
"feelist_id": "a1f803a3-43a3-44b8-b0c2-225acd89c453",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f0cdc05a-8b0c-4f47-93e5-f13f6a774c38",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "32506128-5852-4537-95ac-06bc2a130586",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-10T05:39:20.490893+00:00",
"db_currency_id": "6e65fe77-1922-4c3f-b5c5-f46e14d18967",
"db_currency_code": "sample string 10"
},
"company_type_id": "22ffadeb-c53d-4d33-8255-ef193b0e7b44",
"company_type_name": "sample string 32",
"company_type": {
"id": "8e35ef79-499a-4088-b19b-ed5302a35fb2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a86c0cd1-0294-4af5-a561-d1bd349d6d7e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5070f133-29b6-4ed1-895e-2cbed24e8ebf",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "494cfa36-5203-4e04-bd60-cb9dee0c343e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4a245773-78d0-492c-982e-66ac17cce6ca",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f785cf09-3441-448c-b22e-39087a6c42fc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-10T05:39:20.490893+00:00"
},
"company_sector_id": "27fa50e8-6a1f-4f85-a737-786e3812c413",
"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": "7c6a5d41-c7b0-40ca-9d30-dbe1d5bab962",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a41cacfa-723f-45dd-937e-d9c9d84296aa",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "02d58cbb-e383-4510-a999-4c969e730555",
"account_manager_user_code": "sample string 56",
"company_status_id": "f89cef07-b03b-48f4-a20b-5b851a33df14",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-10T05:39:20.490893+00:00",
"id2": 60
},
"db_language_id": "2ed78efe-bfeb-459d-85f9-f6544572bf7b",
"db_language_code": "sample string 7",
"db_title_id": "508c9211-7a68-4822-9276-9aafe70a0151",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-10T05:39:20.490893+00:00",
"create_date": "2025-11-10T05:39:20.490893+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-11-10T05:39:20.490893+00:00"
},
"modified_dateutc": "2025-11-10T05:39:20.490893+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": "abce96df-8db2-4146-9561-da56e0160936",
"_parent_id": "5c9e408a-561e-4015-a04c-db4d517bde41",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "0dc38361-720a-4c54-8355-77b3e90997b0",
"company_id": "466c76ec-1440-46e2-b1ba-6cf6555856a6",
"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": "1b0b193b-a6ae-41ff-8b4b-f7e33c193a70",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "5e7bfc1a-519d-4ef2-b470-4580b65fa4a9",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "09c77bf3-c7cc-4618-b5bc-c0804832d7cc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "39b62103-4d05-49ed-b256-9a93a31c9d60",
"company_code": "sample string 5",
"company": {
"id": "d7e5b57c-be50-4ea9-b233-1b90a2421bc1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-10T05:39:20.5065173+00:00",
"sales_territory_id": "8fe4d772-2e9a-42ac-92d3-a2c867187170",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9224eace-f6e8-4dd2-8197-68cefbf63bd7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dc442fd3-dcec-47c2-ad8e-295f0955e099",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d0305fd8-3731-4b05-af1a-10843d6f96b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42ef41d6-c47b-4099-a545-57ef364f4d71",
"db_currency_id": "664e55b7-45ab-4ebe-b6a0-3245a3308809",
"db_language_id": "4e3b3cec-6510-4c0a-a541-761a4690570b",
"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-11-10T05:39:20.5065173+00:00"
},
"modified_dateutc": "2025-11-10T05:39:20.5065173+00:00"
},
"marketing_segment_id": "02f8c416-8510-4027-acde-5b2d8b9559a7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c522e827-b4ce-4465-80a6-7b8bb31a54e1",
"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": "d89dfb4d-5ed8-4092-9c4d-92f8149b1ccb",
"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": "b8f8e779-5b44-4d1c-b230-5b3192124e68",
"db_country_code": "sample string 28",
"feelist_id": "509c9917-ada3-4778-b28d-598583f8b041",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9cfb4945-def9-4df4-8f9a-70766bfc418f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0213e1db-f71b-4384-ab89-a4e6e8c2b2c4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-10T05:39:20.5065173+00:00",
"db_currency_id": "5dd8ca6f-30c1-4263-a454-4e765ff77ba8",
"db_currency_code": "sample string 10"
},
"company_type_id": "3007f73f-9cd3-448e-95c9-5ca128c79d3d",
"company_type_name": "sample string 32",
"company_type": {
"id": "6efd5416-316f-4523-998c-c7e4523d3865",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "67dc1370-39ce-4ab5-8df9-80039397ef85",
"sales_organization_code": "sample string 5"
},
"db_language_id": "43c6c5ca-6492-46de-8a1a-684a431999cd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b61ba4ce-2c3d-4fdc-bfaf-e270fccd8d04",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "37540a9a-1c07-4d53-814a-31e478102c23",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0e26628e-ce24-4240-bfc9-d522d79cf65e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-10T05:39:20.5065173+00:00"
},
"company_sector_id": "8a204494-806e-47ca-a677-418749cbf2ce",
"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": "8e1d5fad-a96d-49e5-a266-926fbf5ad515",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d250f227-c31c-4b2b-92a4-ff11f936be77",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8f13d751-7602-4c53-8719-bc83e7b6dd66",
"account_manager_user_code": "sample string 56",
"company_status_id": "8fe63d59-bbe4-48c1-a1d5-2848aeb807af",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-10T05:39:20.5065173+00:00",
"id2": 60
},
"db_language_id": "77c6b9e0-c3c1-4420-996f-cdeb97f94c52",
"db_language_code": "sample string 7",
"db_title_id": "416870a8-df1c-46d0-a371-eaaed727fe45",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-10T05:39:20.5065173+00:00",
"create_date": "2025-11-10T05:39:20.5065173+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-11-10T05:39:20.5065173+00:00"
},
"modified_dateutc": "2025-11-10T05:39:20.5065173+00:00",
"id2": 22
}