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": "7af25a05-299e-45c4-99cd-8ccc5ae6482d",
"_parent_id": "40ce5a36-6b73-4d47-9bd1-18cb6dd9ee7f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "cf088819-075b-4047-8fca-4b896ff04617",
"company_id": "fb73feed-79b4-4b0e-a182-1e6c06cb6cf8",
"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": "ad06d6f3-ad0c-4286-8f87-c552cfad3df4",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c2321f61-15ea-4e9f-b025-af604be410bf",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e10c70a0-01c4-42ed-a6b7-2633f62bc980",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b2373005-d29d-4bdf-a499-c239338caa0f",
"company_code": "sample string 5",
"company": {
"id": "4c570a4e-76a7-4f2e-b946-8a8ca37fc775",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-16T04:33:12.9196266+00:00",
"sales_territory_id": "6be99a72-893e-4f66-958a-2e449ab60999",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ef4b6476-8e60-4d0e-8bc0-f6c67f781514",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ec97215b-b835-485c-ab35-317fc24040c8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5e37e09e-2374-40c6-99df-9db51ebb15d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a375b329-0b78-4d88-8c43-337a0d581f9b",
"db_currency_id": "3f2496ef-6360-4f50-92c7-97192c101a58",
"db_language_id": "0a0a9f9b-8c82-48d2-88a9-5b4cbe5285fb",
"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-02-16T04:33:12.9196266+00:00"
},
"modified_dateutc": "2026-02-16T04:33:12.9196266+00:00"
},
"marketing_segment_id": "58f4fdaf-483d-4de7-a12b-130d79f46bd9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7f2237f9-f080-4ae8-a550-1846ac3f1687",
"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": "241c7f40-d062-40d0-8c05-fa2d4087f9d6",
"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": "4172d321-5b34-4375-82cd-85f12f570dc3",
"db_country_code": "sample string 28",
"feelist_id": "bc82db7c-5d78-4277-a5af-26033ca8711f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "640438b3-385f-4744-b5fe-45cff4c507c9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2eb477a8-40f1-4cd8-856b-aefbb7154c5d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-16T04:33:12.9196266+00:00",
"db_currency_id": "b5848097-e2c0-4c4c-a06c-0c4699bd54b3",
"db_currency_code": "sample string 10"
},
"company_type_id": "2d49ca42-e293-4368-831a-6687aab7757a",
"company_type_name": "sample string 32",
"company_type": {
"id": "234283d4-2754-4a5a-9453-8e32f17a5bad",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6502b9c9-bb26-4c09-9e98-219bd7190816",
"sales_organization_code": "sample string 5"
},
"db_language_id": "18ce2387-e6a2-4e29-bbdd-48f3c8044263",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cdc56fa2-ba8d-43e5-b519-81d3c71bc2e8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "255cd4cb-dee3-473c-8f0e-9fbb2b52fcbd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f694aa41-0b54-4462-b6f2-7de4e72931c4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-16T04:33:12.9196266+00:00"
},
"company_sector_id": "7d698b12-1993-48d7-80a2-57c57c31b453",
"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": "173afac0-abc6-45a0-9376-5ed025c600df",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "684d470c-6ada-4e22-ae4a-cb5b7b0f1e27",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cf61cf39-d717-4cd6-bbd8-0b33df0b9d2d",
"account_manager_user_code": "sample string 56",
"company_status_id": "a3fa6cca-f5c9-4b15-91d9-9cb0e7a145fc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-16T04:33:12.9196266+00:00",
"id2": 60
},
"db_language_id": "0f4dacba-640c-4e62-83c6-8ce6500d6ac8",
"db_language_code": "sample string 7",
"db_title_id": "16e50fff-8eec-466e-b992-15241c0053b7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-16T04:33:12.9352486+00:00",
"create_date": "2026-02-16T04:33:12.9352486+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-02-16T04:33:12.9352486+00:00"
},
"modified_dateutc": "2026-02-16T04:33:12.9352486+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": "ca8a1dc5-7e85-4247-a61d-35694b2eaece",
"_parent_id": "a6e3efa8-86d2-4cb9-8b80-509a5992b026",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9a9ff040-4c7a-4469-9a02-f30ea58c96d6",
"company_id": "cadeeba1-1419-4e9c-a1ff-d817624c3a0c",
"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": "c2901c8c-2155-4fd5-aa53-666fec7be756",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a19467c7-0411-4caa-935c-7bf4452fb852",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6c187f50-0fdc-4591-9cf9-65360fe9cbd9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "91a2161a-75e3-44a2-b224-716e07a5c4e5",
"company_code": "sample string 5",
"company": {
"id": "71a1c99d-933c-4b81-85d6-1b6aa1af0cfb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-16T04:33:12.9821322+00:00",
"sales_territory_id": "ad85cebf-70e1-4e0d-b78a-e02074f08cbb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "07ff2c0c-f51a-4858-b24b-bccf391f33c1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dbe4764f-8a41-4229-9883-63121b8a82d6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f816e0cf-3abb-4466-88db-c2b8dfef04c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a1748749-1c53-498c-a333-7474feb59784",
"db_currency_id": "f4fb0b35-e850-4a17-9450-a1c1d46c3e41",
"db_language_id": "9899cf30-d55c-432c-9cc2-b71dedddb16d",
"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-02-16T04:33:12.9821322+00:00"
},
"modified_dateutc": "2026-02-16T04:33:12.9821322+00:00"
},
"marketing_segment_id": "8e23a588-4f03-4014-a101-3227be59ad47",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "099b8ccb-693c-4ae0-98f4-439e7756a957",
"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": "298ceb43-a58d-4cad-bac6-0d2c33d1bd63",
"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": "0d761739-7cd2-41e5-a770-c03c2dd171a2",
"db_country_code": "sample string 28",
"feelist_id": "d08eae71-3c50-4b39-a0e0-225b71d8d7ac",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1412fe08-80df-4740-adbd-43cfff61419d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "50a4e7ce-2dac-4d02-b8da-60b11d4b0de8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-16T04:33:12.9821322+00:00",
"db_currency_id": "96c1a233-d7af-4e2f-8cc0-b0a502374ba6",
"db_currency_code": "sample string 10"
},
"company_type_id": "f389ff6d-24b1-4af8-8b03-9852206834f9",
"company_type_name": "sample string 32",
"company_type": {
"id": "aab798fa-d9f6-4147-9993-5cf0738a8f25",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ae26c366-69e7-4bc2-b375-ec0c67dc2151",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3579ada7-943b-40f3-8d6c-5d73279e90a2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8be167d6-c370-4ef7-bfce-84ba924cba4b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "89ce1062-3880-429b-b781-648f94c4251f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5982e4d7-a04c-4726-9f76-e69db47e9207",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-16T04:33:12.9821322+00:00"
},
"company_sector_id": "b0941301-48a6-4882-990e-7d205ffed3cd",
"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": "b64c5870-7fb1-423b-935b-8a44430af409",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c1a02a5c-f98f-46cc-b80b-b835af782156",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ac1ebc54-3191-48c9-9f43-d02312f3030d",
"account_manager_user_code": "sample string 56",
"company_status_id": "ea857136-25ba-4ae7-958f-24e246241869",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-16T04:33:12.9821322+00:00",
"id2": 60
},
"db_language_id": "f65982f4-771c-4e56-b07e-0a58c73707b3",
"db_language_code": "sample string 7",
"db_title_id": "601f8938-485d-421a-95ef-6985ef51b57d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-16T04:33:12.9821322+00:00",
"create_date": "2026-02-16T04:33:12.9821322+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-02-16T04:33:12.9821322+00:00"
},
"modified_dateutc": "2026-02-16T04:33:12.9821322+00:00",
"id2": 22
}