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": "56f085c9-5f07-40f7-9640-9163732f2ecb",
"_parent_id": "2f1c64bb-89bb-457f-9a75-3aac7fe11d3e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a98859da-c16f-41e8-b5e8-8324539a77ea",
"company_id": "e49b99a2-1d23-4847-80d3-a2cad6b9be64",
"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": "f916a21a-929f-4eec-858e-18fabd7e5b84",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "27005ce2-ea35-43c7-92bf-cc36cb713563",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "40e92dc8-f58b-4265-ac0d-82947062e39b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d07a6bbd-cbe2-4bba-92a8-095c76d06786",
"company_code": "sample string 5",
"company": {
"id": "0aae38f9-e1d9-4956-8194-01d18e0d1f48",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-03T03:47:54.6429346+00:00",
"sales_territory_id": "d5436ced-3412-4187-9423-5fbb6d3f1724",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f60e5f51-2296-4e93-87af-05b194a9b550",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ccaa4cf9-5f46-4c02-82f6-7632140cbf2d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1365bcab-46b4-43fc-b423-6e508ab1ef2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c76f15b-fe5a-4949-904d-ece376464a45",
"db_currency_id": "e89a864c-4aef-4d29-afd1-4f86d68e0930",
"db_language_id": "ec28b7c0-a7f2-4dbc-a68a-00dfa334a1c6",
"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-01-03T03:47:54.6429346+00:00"
},
"modified_dateutc": "2026-01-03T03:47:54.6429346+00:00"
},
"marketing_segment_id": "136ee432-c11d-4c21-9e83-760ff23ad2a4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f8061dd1-eae3-403b-8473-53d974442579",
"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": "fb1134eb-7e0d-44c7-9ef6-9e6d7be87f85",
"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": "64971886-04d0-413a-8ffa-08958ab90a43",
"db_country_code": "sample string 28",
"feelist_id": "85a16e41-df4b-4316-8cf1-b7b4d8dc7e50",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "46ef011a-29ba-4cd0-b008-3c0b0c094a9f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "384afd93-0f88-43a9-a2be-9144eb9ddcaf",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-03T03:47:54.6429346+00:00",
"db_currency_id": "1a4e5f79-7dfb-4178-8144-bc5520a06f0d",
"db_currency_code": "sample string 10"
},
"company_type_id": "1e2ae822-29de-4f23-a7e4-f5e5a7a635ce",
"company_type_name": "sample string 32",
"company_type": {
"id": "00849d1e-2ee5-4d2a-b1d4-3d25ba212a1a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eb54920c-8b6e-4928-9452-56aa85247a20",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e28ab181-e739-4826-8326-2916be5c4d7b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "875948c9-9769-44fd-b756-4c3b43a437cf",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6f152b0f-8aa0-43cd-a7a7-9ff0f53d4ac4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "838a27bd-864e-4df0-9bba-81c57bb3ae89",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-03T03:47:54.6429346+00:00"
},
"company_sector_id": "b3d3b2b6-e9f6-4769-9c12-d47837ea209c",
"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": "e0bf5d77-8666-46ce-aeb4-e59ed2331818",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1948e435-f4f3-4005-8726-b45e7227f9ca",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "59ae08c5-37d8-40b0-8e45-9f9b582a7bf4",
"account_manager_user_code": "sample string 56",
"company_status_id": "078b9005-4fb0-49cc-a31c-50e4f173c89a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-03T03:47:54.6429346+00:00",
"id2": 60
},
"db_language_id": "6f5429ce-f605-43fd-9d03-ffa3e7997af2",
"db_language_code": "sample string 7",
"db_title_id": "d46d1a53-24d1-4b64-ae31-2e5be97c94e4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-03T03:47:54.6429346+00:00",
"create_date": "2026-01-03T03:47:54.6429346+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-01-03T03:47:54.6429346+00:00"
},
"modified_dateutc": "2026-01-03T03:47:54.6429346+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": "b3f2b856-a70e-49a2-8a34-a6d296006246",
"_parent_id": "8deb2fef-8c01-4718-82cb-6504009f9849",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c68234b7-08eb-42f3-bfc3-a92ebb15947b",
"company_id": "f10251cc-1db8-4f63-b5a6-01fd20ff2ac4",
"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": "07f3366f-bcfb-446b-93ee-4e3456a8bf43",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f00fa603-3be1-4350-9923-f1dfbd79fd33",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "40abea72-4dc7-414e-8489-f55983e85801",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ffc8a3dd-6c20-4934-a061-e04efc105db3",
"company_code": "sample string 5",
"company": {
"id": "09657818-4f93-4b36-94a4-1b03bf7f51b5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-03T03:47:54.6429346+00:00",
"sales_territory_id": "0c7a66e6-4ab5-4a7c-8b91-77d0653a0bac",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9c837017-9a3c-43df-980c-09cecabed67e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "597f5f8d-8324-4c81-a63a-897b186f5579",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "31b9e4a2-da6a-46f7-94f2-c5a4d2c66b45",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5293996f-7421-4bc9-b8da-3c3784c4bac6",
"db_currency_id": "5260e168-4df3-4358-9a0d-576231a062ba",
"db_language_id": "d12ac229-db8f-4c99-998a-c496645785ee",
"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-01-03T03:47:54.6429346+00:00"
},
"modified_dateutc": "2026-01-03T03:47:54.6429346+00:00"
},
"marketing_segment_id": "6f950c1c-83f5-478d-b1e8-c2a571959099",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a43cdaed-388c-4ef4-8c6f-c539102ec60d",
"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": "f50a9bf8-ea4d-417e-8061-8212f25e0200",
"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": "4fc5e42b-7a35-4318-bfab-716254961d2f",
"db_country_code": "sample string 28",
"feelist_id": "0f81e5b4-8628-4f27-a491-a68e55bfafbe",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "64132355-0990-4016-92a4-deb99b868c7d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6d46b6b3-b249-4016-9fc1-ff7b2e333c1c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-03T03:47:54.6429346+00:00",
"db_currency_id": "04e062b2-f1e0-42ca-9fb8-b5013c5a8945",
"db_currency_code": "sample string 10"
},
"company_type_id": "16fb1b9d-c5b7-4930-9e29-7e23464414df",
"company_type_name": "sample string 32",
"company_type": {
"id": "a1854a16-955c-4a7b-8797-d3398664bd37",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "24e4a9b4-bd79-434c-a38c-a5f3d326c4c7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0572dc88-595e-44b9-819f-39bd61fefc91",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b681762f-0aa8-4f68-99e2-8340605ceb52",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "56ff8e01-0ca2-4535-abd1-932abe808077",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2e6eb425-4592-483c-8b6c-8e3bb4c04a8f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-03T03:47:54.6429346+00:00"
},
"company_sector_id": "82c33923-165a-4135-8184-d1d15fe3784e",
"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": "1f9fb409-4c8a-4720-850f-5975ad247e02",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "182f130d-d08e-49e0-a5bb-1555c08c725c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0e54f512-97f0-4575-8bf6-b3c97e3b7c85",
"account_manager_user_code": "sample string 56",
"company_status_id": "54f0bc3d-5910-46de-84fe-2abd84ad0bd3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-03T03:47:54.6429346+00:00",
"id2": 60
},
"db_language_id": "b6bd994e-f8b4-4bd0-a68d-96ebb25140f7",
"db_language_code": "sample string 7",
"db_title_id": "89f0dc02-7611-41ff-8e46-6b4263223721",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-03T03:47:54.6429346+00:00",
"create_date": "2026-01-03T03:47:54.6429346+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-01-03T03:47:54.6429346+00:00"
},
"modified_dateutc": "2026-01-03T03:47:54.6429346+00:00",
"id2": 22
}