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": "96f18f14-eb15-4441-b5da-419e0a6316a5",
"_parent_id": "f322d0ab-c729-4993-8e03-2c0b1c37c1b6",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2e11ab83-395a-449a-a400-3806d9edbbe2",
"company_id": "ca95e047-0ce2-4c39-830b-832f504a4dd4",
"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": "fcfecdb8-44bd-4de7-93c3-c404dd073f8c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a857ef51-9a99-4308-b244-b81a42686f28",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "599b5469-09b1-4051-b84d-77489474288c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5ba4ab1e-f7e4-41a0-bade-485eb169f816",
"company_code": "sample string 5",
"company": {
"id": "9e6a5890-7055-4dac-bebd-9c34ef9bc5ea",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-15T21:45:39.5606193+00:00",
"sales_territory_id": "bc519629-6c23-4a6b-b567-553f2967820d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "94c20872-28ee-4013-8b8b-42672f6edcbe",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8a0477c7-1cf1-4763-890a-c121cf55d877",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "603e6f44-aecc-49fa-9aa6-f3a672a84d54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a70fe170-dc57-47ba-8bd5-e1fb8a184790",
"db_currency_id": "a369f370-6990-4de2-b8f7-78a0ae417b0b",
"db_language_id": "cfd419d2-e573-4d8c-97f5-c70a5c86fb76",
"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-15T21:45:39.5606193+00:00"
},
"modified_dateutc": "2026-07-15T21:45:39.5606193+00:00"
},
"marketing_segment_id": "24aaeb91-0068-45aa-93d2-b5b47807c9d4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "eb2209f8-e382-4a7f-b900-6de6d21bd7b6",
"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": "7874f175-d0a9-46ad-a88e-0435b57e40b0",
"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": "cbce1a28-a285-4155-adc4-2fcabe6cede7",
"db_country_code": "sample string 28",
"feelist_id": "b10884ea-e063-4b2c-a467-8ddab59aec14",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "855174b2-44d2-4c36-99ca-9b5057fcc695",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a8331453-2f09-456d-8525-83c3a310db68",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-15T21:45:39.5606193+00:00",
"db_currency_id": "dd451ac6-39b5-4fff-b740-739d1298387b",
"db_currency_code": "sample string 10"
},
"company_type_id": "002a08b7-c28a-4f18-8c6d-6c8c9aab952e",
"company_type_name": "sample string 32",
"company_type": {
"id": "220f93e0-3b73-40e2-ab5d-28491a382c06",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5910e37b-7c0c-4cb5-85d6-74d9a2898135",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2b00c094-4bfd-43f1-8617-98a0e0146214",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b67ff890-e062-4b85-a60b-9a4151b1daef",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7aeeaaac-fd52-42f8-950d-79c22d39d92b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3ff6dd04-a39c-468a-9c89-d5d21fc64eb8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-15T21:45:39.5606193+00:00"
},
"company_sector_id": "cdfe59ca-2b4d-4e00-b38d-5b5c5d74366a",
"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": "71afbbb4-1013-4455-bb79-ba9d3b388ff6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "25d55016-76d1-4bae-8e77-2817714f38f5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9548fe84-9116-4b84-82e1-5472dd1b25d7",
"account_manager_user_code": "sample string 56",
"company_status_id": "e878033a-0865-4758-aacf-03809dfa6cf8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-15T21:45:39.5606193+00:00",
"id2": 60
},
"db_language_id": "f189a29e-8e68-49cd-a66c-7647cbf9970e",
"db_language_code": "sample string 7",
"db_title_id": "b2270351-8eb3-4698-83fb-bfd330081743",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-15T21:45:39.5606193+00:00",
"create_date": "2026-07-15T21:45:39.5606193+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-15T21:45:39.5606193+00:00"
},
"modified_dateutc": "2026-07-15T21:45:39.5606193+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": "de3d3fca-d6dd-4d01-9a2b-7409cb0b1950",
"_parent_id": "98920a14-6542-452e-927b-ab40936a0077",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c68856e1-3a0a-4466-a977-8d0e52a77148",
"company_id": "627dce21-7da9-4b69-af5d-21cf7bd57219",
"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": "b373cfc9-4965-4336-a710-dd6b6a469ace",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "8c43839a-9f2c-438e-8ecc-38134005d366",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3287e0c0-60ea-415c-b14d-eaa82d7044d2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "85669f12-d675-4964-a6b8-2a072257ab8d",
"company_code": "sample string 5",
"company": {
"id": "a3bfb77e-8881-4d47-b758-57afe4fc0029",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-15T21:45:39.5606193+00:00",
"sales_territory_id": "903e9cd2-af99-410d-892e-ee150f46a05e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "da16781a-a435-4f3d-9e4e-5e7760a6ddc6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "55133314-9764-424f-8eec-c32945243dd5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e6488c72-77d5-4567-a1bc-8a2355a18026",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1833545b-3bfb-4170-bee6-2726c85dcfdd",
"db_currency_id": "86b87582-1890-419e-a302-31a8d3a997a8",
"db_language_id": "9b4712ac-5158-4a36-87b9-f5645f6a72b0",
"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-15T21:45:39.5606193+00:00"
},
"modified_dateutc": "2026-07-15T21:45:39.5606193+00:00"
},
"marketing_segment_id": "e709a565-b169-4724-b253-acf3450335b3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3271a160-32a5-43c5-b948-4ad67edaea4a",
"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": "9adccb80-2f4a-4796-83ff-085e225fe000",
"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": "e30d4fc3-89fd-4134-ad1f-5f8940d43445",
"db_country_code": "sample string 28",
"feelist_id": "6fcc1726-971e-4c0b-96c2-ee3a2fb1a1f7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fbc04fb2-feb2-4777-a86e-2342401231e4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5d392a5c-e2f9-46ab-9c58-de3fe37f230b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-15T21:45:39.5606193+00:00",
"db_currency_id": "1cedecb8-befe-4888-bd68-235f93808c2e",
"db_currency_code": "sample string 10"
},
"company_type_id": "342497c0-6595-41fc-8bf6-e70aa992fde9",
"company_type_name": "sample string 32",
"company_type": {
"id": "9122fe0e-c5ff-4658-a93f-90493abf18b3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ac34c4f0-0b0a-4b88-bc2c-2b235d7036fa",
"sales_organization_code": "sample string 5"
},
"db_language_id": "68f577e2-f325-4803-8743-c610fbe4f442",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d2d1b974-5515-4abc-8e5e-f23202d2ad20",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "03ee4b5f-04c7-4910-aaa6-0982258a9ef5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "14440e68-b5f2-4607-8974-1fc74b56b30a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-15T21:45:39.5606193+00:00"
},
"company_sector_id": "d1229399-3904-4974-8109-ea7542adbde7",
"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": "d187bed8-83bb-41e2-a80b-805b7fe3b2aa",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2dd3f821-780f-435a-a27d-0f8fc616465c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "048c0f5c-4936-4604-ba1b-438ed42df699",
"account_manager_user_code": "sample string 56",
"company_status_id": "99692776-30f5-4f0d-8036-cd311beacf84",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-15T21:45:39.5606193+00:00",
"id2": 60
},
"db_language_id": "1d258ea2-9da1-45fd-a010-fd8682fbc00b",
"db_language_code": "sample string 7",
"db_title_id": "83130c6c-49d6-479a-9dce-c97eed2aadc4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-15T21:45:39.5606193+00:00",
"create_date": "2026-07-15T21:45:39.5606193+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-15T21:45:39.5606193+00:00"
},
"modified_dateutc": "2026-07-15T21:45:39.5606193+00:00",
"id2": 22
}