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": "ba9b403a-f1a5-4685-aacd-5f7595a15a89",
"_parent_id": "96e5de45-9a06-4cfa-a37d-2eabf587e52f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "7923cce1-76eb-47d2-8feb-6e58b0d7e970",
"company_id": "b6877d5a-3d85-4c25-841c-36686c96eb96",
"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": "68bc11ba-3b83-4dc7-bd2e-ff705297241e",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "167ace7e-8c39-4926-89bb-0924555aabbf",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6c140b81-9865-4103-9551-fd9daac3161d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9156d0ec-3e0a-42dc-aeb0-762939083c50",
"company_code": "sample string 5",
"company": {
"id": "24187a7c-fab7-4b39-8e3d-6d8a33adc2dc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-05T17:48:43.4478357+00:00",
"sales_territory_id": "9987fdc6-2686-493b-85f2-85700c67483c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "742eaa98-13a6-4bd6-b568-f039ade2a2c5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ba9c39cc-036f-4303-ab70-af056f3de52c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0eba1e4c-97d7-44a2-86b4-7405964a2b6e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4938b650-2c5c-46ff-8070-1d323c748d2a",
"db_currency_id": "9a94e7fa-82af-4ebe-b790-9e44c2b89fbe",
"db_language_id": "64dc9cc3-538d-4cfb-9ee8-b7e09497c86e",
"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-08-05T17:48:43.4478357+00:00"
},
"modified_dateutc": "2025-08-05T17:48:43.4478357+00:00"
},
"marketing_segment_id": "a9d6f842-25fa-4ca9-9080-81027c9fa40b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "28dc7bdf-d51f-43a4-bc34-e69d5502b1fb",
"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": "332aba45-3029-4ce5-9928-4d0e846f58d6",
"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": "d67b1193-1544-4ab0-9eb2-77e74851e2c8",
"db_country_code": "sample string 28",
"feelist_id": "31389444-1f46-45ed-8504-21ba008e89be",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4658c4c4-87ac-4df2-943b-fd33784db565",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8cb88cdf-6404-4494-ab97-72319bde11e9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-05T17:48:43.4478357+00:00",
"db_currency_id": "0acb716f-1762-4ad1-8a57-c18789a814ba",
"db_currency_code": "sample string 10"
},
"company_type_id": "4e1d0f4c-d43b-4810-b8cb-da7aae4a99c2",
"company_type_name": "sample string 32",
"company_type": {
"id": "0851201f-394a-4d00-9e7c-6faf5b8ac13a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5309d442-eae4-4ad5-a5ec-a373c3afd065",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b803f25a-506c-4570-a645-e92d6c238a51",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d07fb9ae-b4af-462e-ad4b-2fb1adea3e30",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "943e98b8-f097-4fa9-9912-335c2d19bd9f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1ea00f65-453e-4386-af73-e95896b56715",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-05T17:48:43.4478357+00:00"
},
"company_sector_id": "52603d68-23b6-4151-b27c-30b3181dad72",
"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": "59a98581-d5de-4dfc-8ff2-d8822e027fd2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b76b510d-ee1d-471d-be93-97574bd0649e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bbb0c3c0-d4f6-41de-b947-952b2f5380b5",
"account_manager_user_code": "sample string 56",
"company_status_id": "4a65e171-e3c2-425f-8ccc-0469b42417ef",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-05T17:48:43.4478357+00:00",
"id2": 60
},
"db_language_id": "d4105822-724b-496e-9394-1b1aefc78ba0",
"db_language_code": "sample string 7",
"db_title_id": "f98cba84-7650-41b8-8ab3-8e06b12184f0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-05T17:48:43.4478357+00:00",
"create_date": "2025-08-05T17:48:43.4478357+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-08-05T17:48:43.4478357+00:00"
},
"modified_dateutc": "2025-08-05T17:48:43.4478357+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": "0ee9e91a-0b35-4c9c-9239-558370a160c2",
"_parent_id": "2de5f2a7-effa-472b-8383-26f87eaca878",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b56fab5b-097d-4b78-8a86-d1305d267b27",
"company_id": "6cf69186-eb6c-452e-99da-68a453b53b58",
"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": "5155614e-3b9c-40e3-8f48-5a6f157df09c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "9aeb78b8-d94c-4e2e-a9ad-efc1839b2b99",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "119b02ec-64ab-4289-a3c0-c7eddce6edd1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3455f331-04e2-4847-bd75-b03369ce23d6",
"company_code": "sample string 5",
"company": {
"id": "e835038f-5662-4621-8a98-aa48e15333b4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-05T17:48:43.4478357+00:00",
"sales_territory_id": "df379a0b-fb3c-4f11-97cf-3f5180909ddd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bdbe104a-abf0-415a-8b62-9bea83359fa1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7c1abfe2-485f-466c-8f51-657fd9d10de7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "592a725a-6250-488d-b799-c7b2158bcb5b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8f3f4965-bffd-48c4-9d73-c72d486f2b89",
"db_currency_id": "d9fbda0a-0a2a-46b0-9c38-ebb18b8f626f",
"db_language_id": "9d5f7f0a-351f-47e7-9348-5200f273eec5",
"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-08-05T17:48:43.4478357+00:00"
},
"modified_dateutc": "2025-08-05T17:48:43.4478357+00:00"
},
"marketing_segment_id": "c9353180-2059-4843-a72a-e4d2ad342033",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "03c81ec8-0502-4e61-8630-76e367415cd6",
"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": "3ce02c39-c340-47c8-8575-37fe99c41ae5",
"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": "9f671424-6487-4879-a9b4-a290dad63460",
"db_country_code": "sample string 28",
"feelist_id": "4686954c-a3dd-40d9-b0a4-e93be32decf9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fe3e24c0-b971-417e-ad61-86ed3944fa1b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9cd284e8-c033-4095-a2cf-66ce7ff6ef72",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-05T17:48:43.4478357+00:00",
"db_currency_id": "4da4d5b3-62a3-44c4-ad95-b5469b7cf6fb",
"db_currency_code": "sample string 10"
},
"company_type_id": "0a7fb52c-6cbd-47c6-b063-bc9b41e30959",
"company_type_name": "sample string 32",
"company_type": {
"id": "e97da581-e8cd-4ea6-8e90-fb3598eaf119",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ac4e0580-ad4c-4b1a-a1f6-b5966d49c33a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5b54a0be-56c3-4fdd-9d90-f7015628d1f6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "915edef2-31a6-4bc1-b2fa-0ef36334d266",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f88eb685-c612-4c24-bf5f-7c13cf39365d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0b644631-03b8-4fde-804b-28fa6c5f22b0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-05T17:48:43.4478357+00:00"
},
"company_sector_id": "ff738978-4166-4914-b8a1-0d025352331c",
"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": "da9e0fe2-17c5-49a5-bdc0-fd944297fb4e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "91edf4cd-9d8a-4572-98d2-8a88fe387902",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "535a4cc7-b615-490a-96a0-3998e93934e4",
"account_manager_user_code": "sample string 56",
"company_status_id": "dd7c153e-9dc7-4b3c-957e-44e67dddb00e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-05T17:48:43.4478357+00:00",
"id2": 60
},
"db_language_id": "289b6f60-f14a-4b44-91fb-00a006f2eac9",
"db_language_code": "sample string 7",
"db_title_id": "6dedf298-fa94-41b0-bb03-0a6b17c22432",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-05T17:48:43.4478357+00:00",
"create_date": "2025-08-05T17:48:43.4478357+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-08-05T17:48:43.4478357+00:00"
},
"modified_dateutc": "2025-08-05T17:48:43.4478357+00:00",
"id2": 22
}