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": "b8ac6e3c-34b4-4a4f-9cf3-540176a9e143",
"_parent_id": "e2f00436-e9b9-4462-968b-60b09b6a176a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b13a0df1-5555-4e04-b4e6-025058bfacda",
"company_id": "b570cb47-5caf-4fe4-93eb-59f2d5a80744",
"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": "35a10722-2fb7-4205-a1b6-e7b1c12d3b33",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "cac45187-aea1-46a1-92e5-160cb380e55f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e4849be3-c9ea-436a-8748-c689724dfad3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "48add1ad-2e84-472c-a126-e02a1cc475b6",
"company_code": "sample string 5",
"company": {
"id": "0edf5cad-99c8-41fb-bf59-9909c883759f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-10T02:52:05.2218315+00:00",
"sales_territory_id": "a48330ea-3986-4d87-9920-9c0a705bd40d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b82a13cc-4ebe-4bd6-9172-f1c1f1210e62",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c4e043ab-52c9-4ac4-8485-18478ccc613d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4efc3c39-fb17-4265-b37e-ec96ec5d85fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb524615-5d96-4823-84c3-096b7263e94c",
"db_currency_id": "5de48e5a-3b3b-4678-bf9b-dec031abf33e",
"db_language_id": "4dbe03dd-7ab2-4b23-ae12-c04b95812c05",
"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-10T02:52:05.2218315+00:00"
},
"modified_dateutc": "2025-11-10T02:52:05.2218315+00:00"
},
"marketing_segment_id": "041f8140-fe68-4ad7-8093-8bdfac5192a4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9e1d8549-f7a1-4255-8cff-76c3a02bc273",
"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": "23048fdc-a663-4cbb-8597-9474327627af",
"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": "19929804-1a32-4ee6-817f-8e73ed704f84",
"db_country_code": "sample string 28",
"feelist_id": "9ebdb572-1aef-4445-aa2c-8197b6ff6bb6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4a14e74c-1911-4318-b8b3-6cb4f180a8cc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e0525741-a836-4225-bb5e-800f5a62d5a7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-10T02:52:05.2218315+00:00",
"db_currency_id": "5aa402f5-f033-4572-8c91-cdb48c51e1bf",
"db_currency_code": "sample string 10"
},
"company_type_id": "10cc8386-0ab1-49a0-9784-c8e64ab37b1a",
"company_type_name": "sample string 32",
"company_type": {
"id": "06173473-b3a1-40e6-9c1e-40492c945b71",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dfb0c356-7f85-4be5-8fbd-d2ac1fc6061f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d61211ea-a073-4891-bb02-0f1c70e59aaf",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f3333494-86cd-43b4-8170-b48840fe1765",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "66af9344-7ed3-4915-94ee-06ae9e642b1a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8efb8112-0c19-4a0b-b38f-df1859d255f5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-10T02:52:05.2218315+00:00"
},
"company_sector_id": "ce198f9a-0215-46eb-9998-9b1334babad0",
"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": "396ffb5f-d500-4cd9-8612-e3820dd88713",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e620b9e4-d4a3-4a88-9d14-644d2a329598",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bf77b674-9399-4e2c-92d8-5641f65042f2",
"account_manager_user_code": "sample string 56",
"company_status_id": "dffe919d-ffb1-43d0-a760-af4a38982bd3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-10T02:52:05.2218315+00:00",
"id2": 60
},
"db_language_id": "e4dc7f8a-59a4-44cf-814f-5473a5b14bbc",
"db_language_code": "sample string 7",
"db_title_id": "eb130ae0-006b-4744-8ffe-2c87f91d18ce",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-10T02:52:05.2218315+00:00",
"create_date": "2025-11-10T02:52:05.2218315+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-10T02:52:05.2218315+00:00"
},
"modified_dateutc": "2025-11-10T02:52:05.2218315+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": "0a92e242-bda1-49a6-a3ab-664fb029bb18",
"_parent_id": "856b15dc-ab8a-473a-87c9-b0ec5b68eeed",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9bebe8de-9238-468b-9c1b-9d781cdd5c9d",
"company_id": "593588db-31cc-40dc-a327-8c539fee20ec",
"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": "cfbd9786-b9ca-4389-9889-8d7f862a7558",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "648e3b3c-0b77-4f03-a127-14cd9e33fdb2",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ff783344-08ca-4f6d-8dfa-00db29453ee7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dc64d486-739b-4c9c-a4f3-11a997ee060d",
"company_code": "sample string 5",
"company": {
"id": "35ab5cbe-f8d9-4173-bc3c-a8d1c35f002e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-10T02:52:05.2218315+00:00",
"sales_territory_id": "2f0eb36b-f95e-4b24-93ba-b44c06038322",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "15ebabeb-9617-446b-b873-f518b358825e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3a28fb6f-d05d-4f21-9dc9-e2bf7e17240c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4134326d-de8e-4e6e-baf4-b2616d3fa778",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b90a64eb-053d-4448-bd40-c81e0b863f26",
"db_currency_id": "067489b6-bb38-4672-9ea8-13deec5ab6c8",
"db_language_id": "01490744-6331-430d-b138-6bbc150077eb",
"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-10T02:52:05.2218315+00:00"
},
"modified_dateutc": "2025-11-10T02:52:05.2218315+00:00"
},
"marketing_segment_id": "e4d2666f-8483-4540-8180-c54b8cbcfcae",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "abecadaa-c2d4-4cc8-b008-0847ad472037",
"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": "51478b7f-b179-4ad1-b478-e655ec621b7e",
"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": "87665e8b-f336-449d-99bd-b8f40356093a",
"db_country_code": "sample string 28",
"feelist_id": "da768615-e8da-4c4f-b0d3-89e5760fb9fe",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e253647b-cf6e-492d-8fe5-da29fd39c109",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "74c937ba-9efb-4233-9c97-5341a5202263",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-10T02:52:05.2218315+00:00",
"db_currency_id": "20ae911b-dc92-4c0e-997f-fcffaac6e46f",
"db_currency_code": "sample string 10"
},
"company_type_id": "e782877b-ff08-4df6-a393-27cd590fe439",
"company_type_name": "sample string 32",
"company_type": {
"id": "97400213-603d-4a57-9c68-1d2f59014a7e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "289622b8-f790-4e51-ab52-ea768c4fd5fd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "083b29f8-cb19-4b36-8199-44803e09309a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7aecedb4-5d1d-44bb-8808-c985a6e764a1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1e8869dd-4932-48e5-af6c-87cf98ff3d4d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c264c681-a5e2-4f4c-846a-7779969d375e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-10T02:52:05.2218315+00:00"
},
"company_sector_id": "01fcff04-a3f8-4c42-b62f-ca55e24143ac",
"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": "e7506be5-e2b6-4593-8acd-bd42db23652a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "89ce5736-a5b5-442a-acd8-f488779ae613",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "148b221d-11a0-4493-a6ae-0cb3068ee96a",
"account_manager_user_code": "sample string 56",
"company_status_id": "e971417d-1947-4c36-a4be-08d4eeccdcb5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-10T02:52:05.2218315+00:00",
"id2": 60
},
"db_language_id": "8689ebc1-c96b-41d1-ad85-96d2b9d01395",
"db_language_code": "sample string 7",
"db_title_id": "3a45e2a3-f49f-4909-801a-1f46af56057e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-10T02:52:05.2218315+00:00",
"create_date": "2025-11-10T02:52:05.2218315+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-10T02:52:05.2218315+00:00"
},
"modified_dateutc": "2025-11-10T02:52:05.2218315+00:00",
"id2": 22
}