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": "4c62f2ff-2cbc-4a0b-a682-d6c10c67f32f",
"_parent_id": "e0433f72-ac15-48e5-949b-fd63c1adfc3d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "195a798d-38c1-42b3-8fce-ce54b4d86a16",
"company_id": "463bf2ed-de15-4c09-9d83-7bfe46f2086a",
"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": "987d5f29-e053-4d42-9973-cf18666fc737",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "04fb36ea-2c80-47a9-8180-b0e708662499",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "43a345ef-76a7-4415-a155-b9ba8449236c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "22701f46-9f0d-409a-ac83-5c327cedbd8c",
"company_code": "sample string 5",
"company": {
"id": "4c7383bd-339d-4255-a8ac-ce87f878ccf3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-04T14:31:52.7822085+00:00",
"sales_territory_id": "2e3c5c19-6be4-4bbf-b75b-50d3d04d06d1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "05cc15f7-d79c-4ce4-a612-309d657385e1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b90be329-79a2-490b-b93a-21f2bdad1de6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "209253e9-c282-4c12-babb-7e58fb42c004",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fdff15ef-46f3-46bb-a2c9-b85bd10094e5",
"db_currency_id": "afab3553-f70c-43f0-939d-3cb9fd265093",
"db_language_id": "e20f1ba2-38b0-4c73-b072-86a780f333d7",
"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-09-04T14:31:52.7822085+00:00"
},
"modified_dateutc": "2025-09-04T14:31:52.7822085+00:00"
},
"marketing_segment_id": "293f3aba-af33-4717-8e05-fb2ad4c3f197",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "722a1441-db3a-4352-910f-036943b4d202",
"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": "798bf468-feab-4a9b-8dd8-f6bb361d3cd7",
"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": "283d544f-899b-4830-87f9-63199524827c",
"db_country_code": "sample string 28",
"feelist_id": "0f3b6b64-e56e-4705-a4e0-4c7f865efcb8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "525331a4-dcef-4f13-a225-851ceba04387",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "17b88854-2d52-46a5-830c-3fa52f64839e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-04T14:31:52.7822085+00:00",
"db_currency_id": "72caade6-4d32-45a8-83c6-b516e3cc35ff",
"db_currency_code": "sample string 10"
},
"company_type_id": "c2adce06-d0da-47dc-b963-959089244475",
"company_type_name": "sample string 32",
"company_type": {
"id": "b648d673-0e47-4398-a8dc-c84b233d5134",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2005bf05-0a91-4b75-b982-7434e5948fa7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "69a280e8-3339-458c-a252-6c27ebd43ec9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bcec933c-28c6-43fe-a58e-d265845d7342",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "49c77275-f2ec-41f0-8cf6-aeef5cafd3d7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "86a33aad-05bf-420b-9a76-27b33803dc57",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-04T14:31:52.7822085+00:00"
},
"company_sector_id": "6fdaf6e4-01a8-49f0-b742-6fee03132bcc",
"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": "e847359d-158b-4505-bb59-5a8f07438b18",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8f6b2be5-7ed2-4052-82a7-a4677da51bd9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "afb96611-646d-4f27-bec1-176fa39ac1b4",
"account_manager_user_code": "sample string 56",
"company_status_id": "677c1553-21e7-4011-8d7a-30ffcbd97744",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-04T14:31:52.7822085+00:00",
"id2": 60
},
"db_language_id": "8dae228f-bed3-4968-992b-a799d9fe4d72",
"db_language_code": "sample string 7",
"db_title_id": "827f0adf-0470-4cd2-94ae-868190178eda",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-04T14:31:52.7822085+00:00",
"create_date": "2025-09-04T14:31:52.7822085+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-09-04T14:31:52.7822085+00:00"
},
"modified_dateutc": "2025-09-04T14:31:52.7822085+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": "90eabf2d-9ea6-4b06-8cd2-1032785efe52",
"_parent_id": "9de88bf3-a948-4b48-8c20-bf4848604608",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "10af92a2-c8c1-4c48-bc70-cfb78fb771bc",
"company_id": "e51ad6a7-0263-4a7f-bdb6-99436984dfad",
"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": "7031f730-d79a-40c9-b462-fb7b13e6df65",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "5c63333b-2b16-43ee-8d18-3608932afe3a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "cb33e32a-04f9-4a0c-94fd-f0c19df853df",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c6e717d9-866b-43cd-ad2c-16977eca9169",
"company_code": "sample string 5",
"company": {
"id": "6fc6ee48-81f0-4034-8b41-1ca736b92bcc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-04T14:31:52.7822085+00:00",
"sales_territory_id": "40e30708-e699-4986-a78d-1196af8bcbf6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f5fec9f7-8c44-4fa2-8754-70c535cf3ea7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0b6b1106-4e21-4d3d-8308-7e8f7227018e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3c8c8a5c-7697-4404-beea-ade901bd783c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87f78327-6e47-494f-86e2-f508ed544b58",
"db_currency_id": "880b9e77-409b-473d-9594-15c41c17c208",
"db_language_id": "acb0a1a7-c873-4807-ac33-6af0f05b43ed",
"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-09-04T14:31:52.7822085+00:00"
},
"modified_dateutc": "2025-09-04T14:31:52.7822085+00:00"
},
"marketing_segment_id": "ae07f548-65c2-4083-990a-066f016389a3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "548e3985-c7cf-47d9-88ca-330779333682",
"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": "479b546f-7069-4ff3-bfbc-62165123e4df",
"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": "28633afe-2e55-4718-ba0d-681c0f932691",
"db_country_code": "sample string 28",
"feelist_id": "0e1b3765-821e-42ba-a318-acb5bb32e5af",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "27a5096a-1299-436f-bd08-5f337466f2df",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ba2258dc-3b8c-4682-8ffe-481dec9506bd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-04T14:31:52.7822085+00:00",
"db_currency_id": "7075ac5c-5b57-4de1-9b3c-b252c844aa00",
"db_currency_code": "sample string 10"
},
"company_type_id": "6f396ce0-75b3-47bc-a656-4d8f6316aaf9",
"company_type_name": "sample string 32",
"company_type": {
"id": "260ce995-15e7-4b36-a3e1-2f17caaf27bb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "176c32b0-0af6-4b68-8167-8450603c71d0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "cfa03a03-4298-4c81-92be-f1e1650647d7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "aa33f41f-a0a7-46e5-b086-4419375f645a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "668ce115-a123-413b-9911-878313e90b0f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5eedd9de-5c41-4c4a-97d8-1d5c033c096b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-04T14:31:52.7822085+00:00"
},
"company_sector_id": "3d8a7be7-cc6e-4cf0-b7d4-d0bfa5b7aa82",
"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": "c8244dad-bb07-4841-ba18-aa0d3abc7416",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a2a8225c-171c-4d88-8d84-e2b1d7a41a97",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8a1fe63a-7825-4b70-a0e1-b5d0e791179e",
"account_manager_user_code": "sample string 56",
"company_status_id": "3d76dc96-03a0-4213-8d06-345b5b1d1297",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-04T14:31:52.7822085+00:00",
"id2": 60
},
"db_language_id": "08c801f5-a2e3-4537-9a4f-ef3e1be76531",
"db_language_code": "sample string 7",
"db_title_id": "2c45a3af-80f7-48be-a2da-c0f6dd7b0573",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-04T14:31:52.7822085+00:00",
"create_date": "2025-09-04T14:31:52.7822085+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-09-04T14:31:52.7822085+00:00"
},
"modified_dateutc": "2025-09-04T14:31:52.7822085+00:00",
"id2": 22
}