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": "b2a7eef5-ab6a-4011-94fc-40baba2cd94b",
"_parent_id": "e851a27b-274f-4802-be29-afcf6f0f2600",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "dad18ab1-eae3-4644-af18-a954aecbe724",
"company_id": "4dcb0cc6-0e1a-46c1-9fff-5b94e3829a4b",
"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": "5c3d15fa-2629-4a1b-8217-170f1e099e9b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "342acb15-1087-4f91-acb4-00ddb5b42873",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "7915d521-dc17-43fe-a61a-86193ef4cad0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a35e8e07-44f2-4bf9-a154-d5fc27a097a0",
"company_code": "sample string 5",
"company": {
"id": "471642e7-2b53-48e9-bd9f-fbb731266c0a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-28T01:09:18.2977308+00:00",
"sales_territory_id": "a1c14fc1-ca7e-4167-9ee5-7c80fd1f0d3a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "43eb39ce-4e77-47bc-bafe-7d787fe880d7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "69cb7291-331c-4113-bc02-c0a577c3e02d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "36e33e4f-64cd-4784-906f-5baa4f2bc874",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b096d847-9eb4-4081-840a-86e4071e6326",
"db_currency_id": "aed8c551-3ef2-44c1-be70-9b7396773c4a",
"db_language_id": "bea8bc02-fad1-4752-9104-98db4413e141",
"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-05-28T01:09:18.2977308+00:00"
},
"modified_dateutc": "2025-05-28T01:09:18.2977308+00:00"
},
"marketing_segment_id": "2b6f4e31-2183-4808-a055-13e7bd63c7d9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fc5b9322-918d-4d30-a24f-7e23d62a2cb5",
"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": "a7fe68af-8ccf-4797-a50c-f50d94b724a8",
"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": "9592a9f9-14f8-47d4-8feb-651a632149f3",
"db_country_code": "sample string 28",
"feelist_id": "6fbf2c9b-ec13-4565-a4a4-7395f17def36",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0c95b1a1-d2d3-4223-b736-0aa2e0d4cff3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5bad7d97-e58b-4f8a-85c6-16391a906180",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-28T01:09:18.2977308+00:00",
"db_currency_id": "72361ffd-eb40-4579-8d0a-4aedc79bc2c2",
"db_currency_code": "sample string 10"
},
"company_type_id": "d1faca43-9d57-4d11-93f7-3b2520bc5a35",
"company_type_name": "sample string 32",
"company_type": {
"id": "557a8adb-bd31-40a1-8d41-58f1ac8674fd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "635c8fc8-9cb1-49ab-aa2b-ac278f4ec9f6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b9eabb58-02ad-4eab-b353-58893ea19b72",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "046aceb0-8e49-46b0-93de-620ee9c6ffd8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a5e5955e-29ba-4600-9d87-f64b467deeec",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "97b3b041-9d1d-4a4b-8e29-49fb9b459d78",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-28T01:09:18.2977308+00:00"
},
"company_sector_id": "57cc3124-a86d-416f-9e4c-6bd38d04bb08",
"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": "423d9717-93e1-40c9-939b-b40cf69d4b4d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5193ff89-0710-4abf-9009-43bba2936a2b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e61d2a98-1dee-4ff6-988b-3e55e59783b8",
"account_manager_user_code": "sample string 56",
"company_status_id": "dde66cfc-72a1-4d22-987c-b02093986e15",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-28T01:09:18.2977308+00:00",
"id2": 60
},
"db_language_id": "a9979d97-c5dc-4f86-ac71-796ef00d6285",
"db_language_code": "sample string 7",
"db_title_id": "243ae815-f426-4e3a-b0dc-572840275cd6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-28T01:09:18.2977308+00:00",
"create_date": "2025-05-28T01:09:18.2977308+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-05-28T01:09:18.2977308+00:00"
},
"modified_dateutc": "2025-05-28T01:09:18.2977308+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": "6dd8b268-f832-42ad-b5b0-48e5005b6760",
"_parent_id": "5c278000-5090-4f01-8615-10a4c4766dcb",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "eae8883c-a52b-4113-94ef-ba646ab1321a",
"company_id": "e1dbf3ac-1491-4293-8f05-d892b6f347ae",
"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": "c315a29f-29f0-454a-a1e7-d82c401d8ed2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "987e8a32-4386-4ded-ba99-632a8ad8d8ef",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "cc326080-4069-4d4c-b283-14dbd367805d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5c716960-7613-4322-8aa7-a4212ac8f810",
"company_code": "sample string 5",
"company": {
"id": "e91b6664-4564-4cbc-8b8b-b0ac022653a8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-28T01:09:18.2977308+00:00",
"sales_territory_id": "825f9acc-84ed-4120-ae6e-53138b6fef4d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0df36200-5c6c-40bb-b350-ef54b81d55f9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a63da70e-2a89-40db-aadd-2717ded30daf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "39ddfe56-283f-4559-83f2-a852064cfcd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6549915-d8f1-4723-a9bd-c5008cdeea17",
"db_currency_id": "103c3520-946d-444e-873f-d98e7bb44642",
"db_language_id": "cf8bb4e1-52ce-44ae-9aad-300d1e6fc0af",
"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-05-28T01:09:18.2977308+00:00"
},
"modified_dateutc": "2025-05-28T01:09:18.2977308+00:00"
},
"marketing_segment_id": "2c4a4adf-a7cb-4b44-a65b-379706280b5e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ff718029-3327-4c8f-9dad-1fd62f339c3b",
"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": "75c3e661-27bd-4f15-9859-f88714eafafc",
"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": "e7db0c5c-5895-43b4-a99b-8941f99e2e71",
"db_country_code": "sample string 28",
"feelist_id": "57dd7f18-4ed5-4b3c-bf76-8da9654371d3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6e695156-55b1-4152-866b-349c590d86b6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fa49b906-7c97-447f-90bc-a3dad1898446",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-28T01:09:18.2977308+00:00",
"db_currency_id": "1722042c-4fed-4071-adce-a24f20d8fa0a",
"db_currency_code": "sample string 10"
},
"company_type_id": "061b55bd-438a-487d-99f1-3aa74f477451",
"company_type_name": "sample string 32",
"company_type": {
"id": "664865d1-078e-4417-aad7-ce1342bd7ad9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b260ef6c-6da3-48bc-8eaf-4443c9def799",
"sales_organization_code": "sample string 5"
},
"db_language_id": "133d462b-2b81-4b5c-9643-da8acb51173d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c5110740-9fdf-460e-8ad8-c8c43085221a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f86ddc29-3c09-4e7e-9978-d4e930c49dd0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "014740dc-6010-4106-9985-bdec39378e49",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-28T01:09:18.2977308+00:00"
},
"company_sector_id": "37f6be93-469a-4549-89ce-84df2e162586",
"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": "9964a202-1795-4e77-bb2f-68609925d493",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d9cc77b0-d28e-4c02-9381-ffbf3bcf7bff",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "441f5525-b47c-4536-9216-9855bfc81f10",
"account_manager_user_code": "sample string 56",
"company_status_id": "a29d111c-9459-4d8d-a362-2f5d5eaa4a65",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-28T01:09:18.2977308+00:00",
"id2": 60
},
"db_language_id": "4a19405f-d033-49e4-9a0f-9d8fe312b67e",
"db_language_code": "sample string 7",
"db_title_id": "afa56268-1772-4b00-b596-31a0b3457251",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-28T01:09:18.2977308+00:00",
"create_date": "2025-05-28T01:09:18.2977308+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-05-28T01:09:18.2977308+00:00"
},
"modified_dateutc": "2025-05-28T01:09:18.2977308+00:00",
"id2": 22
}