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": "3c658911-3eb4-49d2-8010-f2c3098b3e1a",
"_parent_id": "a865b39f-7dad-4bb7-8421-c17f5e802071",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "622d82c5-0ac1-4929-b0be-bb36e71fc86e",
"company_id": "901d38f1-bb89-41c9-94d5-d5f064a0a043",
"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": "97145521-1a7c-4978-98a4-212dc8ae2ae9",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "4fff3e77-4dc0-42c1-a004-90e747f7d008",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "59fcd642-8dac-46e1-bf7f-e47493a79d92",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "569f7bec-8904-46da-83bb-b3ca93f2c6e7",
"company_code": "sample string 5",
"company": {
"id": "04368870-5d08-473b-bddc-18aaf26e1f09",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-01T20:32:09.5066284+00:00",
"sales_territory_id": "02dc6a4d-dea3-4af4-a74e-d7a23e4badcf",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7c842ab4-ef76-4d67-85b6-398e396474b8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "10a33d31-354d-44b1-ace4-322bcd307dd8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "74ad4a0d-dfb9-4f0b-80f6-a1a0911b3d9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24b913a7-e5f8-43f5-aee5-1bd39ba54f6a",
"db_currency_id": "a9c54f63-1680-406f-8e76-fab36e22337d",
"db_language_id": "66166ced-c73d-4a45-9b8b-725565d615f1",
"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-01T20:32:09.5066284+00:00"
},
"modified_dateutc": "2025-11-01T20:32:09.5066284+00:00"
},
"marketing_segment_id": "5a0b9b79-355e-4033-bbf8-f20f1e95de62",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2565ec39-9e77-45d7-b675-acf190ebc81f",
"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": "e8f2afa0-9d94-4897-89fd-f294ed69fc78",
"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": "4e76eb49-e8cc-4e08-bced-f9283fa6cd03",
"db_country_code": "sample string 28",
"feelist_id": "98caa56c-a0b8-4af3-bd3b-1b4f729e04b5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3b8202d8-f7de-445c-8fb8-c1663e9e0997",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a78576cd-aaf8-4980-8d3c-1b4bb607b29e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-01T20:32:09.5066284+00:00",
"db_currency_id": "00ac334a-b01c-4a48-ac2a-97570ed2ee0c",
"db_currency_code": "sample string 10"
},
"company_type_id": "da957013-30fa-4ec7-8cca-1f5436c34558",
"company_type_name": "sample string 32",
"company_type": {
"id": "358440ea-0f74-4060-95fd-1f5365fa0084",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "074b5978-d163-48bd-bc67-7d713f931fc3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "51e08ef8-4b87-42e2-8984-9b312581d670",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "eb1ddbf8-849a-4010-ac7d-9b8c40b47d5f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "aede6f96-1d94-49b7-b763-ec25d348f74a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "eadd284f-ce1e-4b00-8653-276b01b4ce4d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-01T20:32:09.5066284+00:00"
},
"company_sector_id": "ed2e9ed2-1cc8-4759-bcec-4c139e5cf1e2",
"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": "e65fa3e0-71e2-49a5-ba40-540cf10633c7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "790b7051-3157-48c8-9771-0522629887da",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "50c32376-7b30-4323-b2a8-67cb4cd7f9bd",
"account_manager_user_code": "sample string 56",
"company_status_id": "23c061f1-316b-463b-86c5-0c0629e28cb3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-01T20:32:09.5066284+00:00",
"id2": 60
},
"db_language_id": "264e1f57-b081-4b4c-9749-225e6ee683a8",
"db_language_code": "sample string 7",
"db_title_id": "fe6df353-fe52-4d49-aec7-e192e1d06c22",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-01T20:32:09.5066284+00:00",
"create_date": "2025-11-01T20:32:09.5066284+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-01T20:32:09.5066284+00:00"
},
"modified_dateutc": "2025-11-01T20:32:09.5066284+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": "7e3aeb64-2757-46bf-9fbb-e62ad4b8e2ac",
"_parent_id": "d1163066-dc3d-474b-ad4e-54d4c9c562b3",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "be064cdf-9e9d-4b66-829e-88eb5d49c161",
"company_id": "d659129c-5007-4879-b5d9-931e37f44d12",
"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": "89fd5d88-2f95-4923-9b4e-964a874b130a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "96d9f031-e9af-4fe6-a16e-a5f7079de400",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "bdcc0dc4-a412-4b46-af58-99a96f4aefa5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cc253369-01ac-4e26-8e0f-6879eddbdeda",
"company_code": "sample string 5",
"company": {
"id": "ff0ff687-03ad-44fc-9380-a7117350bede",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-01T20:32:09.7722558+00:00",
"sales_territory_id": "4980b4d9-afe3-49c6-84c2-11b88f037bd8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cc8cab02-cb63-4e2e-9755-a604781ea7ad",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "798a69ba-08ca-4734-b13b-547d124e5b57",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "837a7e16-2e5b-4056-a0f1-bebef027c155",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9ed6d1f8-ad8d-4441-9197-a3ce11d77cb4",
"db_currency_id": "cefb7e88-7d23-4edf-a08f-09203f70567c",
"db_language_id": "d25c5bfa-fe1e-457b-a52b-30678bca29bf",
"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-01T20:32:09.7722558+00:00"
},
"modified_dateutc": "2025-11-01T20:32:09.7722558+00:00"
},
"marketing_segment_id": "4dc1aab0-42bc-437b-ab38-d93ede9f47d7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "78c3651a-468d-4120-9906-0c01ae7927ec",
"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": "77b14ae4-2f6c-4286-9075-a3e68a1b67d5",
"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": "64c920f1-392e-4cb0-b39c-711d41b699dd",
"db_country_code": "sample string 28",
"feelist_id": "cdf4ad66-b687-4ab1-a066-fa0f0077980c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "75ea15db-efac-47d9-99ad-8231d04f5c74",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d25104c2-5471-4712-83eb-4d9e0985f6b5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-01T20:32:09.7722558+00:00",
"db_currency_id": "05b2910f-42a5-446a-98c3-dd49f995f7a2",
"db_currency_code": "sample string 10"
},
"company_type_id": "e243b4f1-4a58-4684-b7e9-50aeb6ec1f50",
"company_type_name": "sample string 32",
"company_type": {
"id": "fc9fc05a-781f-4c5b-8781-c7bfdc1e0225",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c9a098ce-2cff-449e-b88f-276d9afe791e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a1057255-eef3-497e-9555-437bc362acaf",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "79bc7126-f284-4d14-952d-1ea637d3836b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f73bfe0b-d059-41a0-860c-77c063bd8b81",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4a2bf23e-73ed-450a-9f10-f097d52ec5e8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-01T20:32:09.7722558+00:00"
},
"company_sector_id": "f37baf31-804d-4045-8c90-bdfe09deb09c",
"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": "8691aca5-05fe-45fe-96d8-1f73efe74182",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "630bf06b-05d4-41c7-bce8-664300b31ade",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "be37b24a-e1fd-4ce6-b3fa-2a95f0d8039f",
"account_manager_user_code": "sample string 56",
"company_status_id": "c48b76c7-f603-4e3c-bb6e-ef915a8f81cb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-01T20:32:09.7722558+00:00",
"id2": 60
},
"db_language_id": "fab6bfb0-5f53-45f2-b905-c67b0041c7f5",
"db_language_code": "sample string 7",
"db_title_id": "131927c2-113e-4181-bd20-fca00dbcdc7d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-01T20:32:09.7722558+00:00",
"create_date": "2025-11-01T20:32:09.7722558+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-01T20:32:09.7722558+00:00"
},
"modified_dateutc": "2025-11-01T20:32:09.7722558+00:00",
"id2": 22
}