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": "b20d64f9-3b64-47a3-9b1a-f66cabf449b3",
"_parent_id": "083ab270-55b5-4b98-b887-2d62831b966f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "96877d74-d4df-4b1e-bae7-d95a45cd8e9e",
"company_id": "9fba9882-4278-4127-8b0a-8ac9443c0e59",
"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": "2194a3fe-acdf-4344-8c48-49e737296f6b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ed8036c4-3066-4f13-89bd-376569c35983",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "204fb84d-49c1-49cf-9121-ffdc295ac1e7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8d163fe5-9a0e-4dc2-bcb2-ec9e407fac34",
"company_code": "sample string 5",
"company": {
"id": "c0360af2-0c68-479a-a380-d9aed68ba9a3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-22T17:48:00.3972537+00:00",
"sales_territory_id": "5771ee28-0864-4fb5-b4ab-67782e7edc18",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4cdb3167-b379-4074-8269-3912c0498259",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c890ade3-a845-412e-ac8c-b211894ab851",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0a3529be-7424-4726-aad5-34111d0abc2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e592f3b-f047-487a-ba82-a61195f61e11",
"db_currency_id": "77b28892-9da3-4ea0-8f54-4747a9e647fa",
"db_language_id": "72e3c825-d9d1-4971-a272-192ea4df4bac",
"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-02-22T17:48:00.3972537+00:00"
},
"modified_dateutc": "2025-02-22T17:48:00.3972537+00:00"
},
"marketing_segment_id": "b4cf9532-7132-447e-9ef0-aeff7714c3d7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f767bc03-d334-4a8f-9018-45ddd5f1fb9c",
"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": "9e4932cb-c065-4718-9a5b-9f3f0c69c049",
"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": "0df08591-bfd5-49df-80a9-d904b67a6551",
"db_country_code": "sample string 28",
"feelist_id": "2338ddfe-734f-4855-8f68-8af09cfea7af",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "db3338de-8c4a-416f-9697-f82711d91a92",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "85bd3ea6-5b7f-4a53-94c2-6342b162c445",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-22T17:48:00.3972537+00:00",
"db_currency_id": "ed4f4853-a490-47ba-ba21-7db35aa6c0d7",
"db_currency_code": "sample string 10"
},
"company_type_id": "11cbb41e-ab03-4892-98d9-c089d45f50a4",
"company_type_name": "sample string 32",
"company_type": {
"id": "78979cd2-b7a5-4d62-8dd0-fcc8fc39601b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6bb4b40d-525d-4544-b8bd-ac1aee7748a6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3bbc7d3a-9f1a-4076-9588-ed92dd2e2a35",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7cdb1f2b-296c-458c-94fb-4c943cf68115",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "359c0646-d813-47e4-a01c-0fa79161ece1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "85fd8860-375b-47d8-afcf-cf1a142f46f4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-22T17:48:00.3972537+00:00"
},
"company_sector_id": "cc75b41e-ce03-4376-b6de-0504a353f777",
"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": "4dc75372-6542-4c03-9168-2a70fa58c752",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f59edbd1-d5b8-4ec6-aa07-b23b4a3302bf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bfd00e92-6750-4403-b96d-fcd385d5bd83",
"account_manager_user_code": "sample string 56",
"company_status_id": "e265e946-a3df-405b-9177-47fabce68331",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-22T17:48:00.4128781+00:00",
"id2": 60
},
"db_language_id": "aacd166f-fc57-4b1a-ac0e-606526b217c0",
"db_language_code": "sample string 7",
"db_title_id": "9c7a2767-e61a-40fb-9c1a-a1da74a54555",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-02-22T17:48:00.4128781+00:00",
"create_date": "2025-02-22T17:48:00.4128781+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-02-22T17:48:00.4128781+00:00"
},
"modified_dateutc": "2025-02-22T17:48:00.4128781+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": "bd2ce6ca-dadf-4a60-945d-768ee486c7f2",
"_parent_id": "eaa45785-ee30-4dcb-90c7-b8155420e6fe",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1fa0d7f9-659c-4e2a-842e-6c95752df9fe",
"company_id": "9a9bd91b-eba0-4620-ac6c-e4cd2fd8cd7d",
"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": "12560c83-77b2-4cb4-8d51-345b1c7f8860",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "9ab25c03-f06d-470a-bb88-471b2a3cfbd5",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "335cb26b-d66c-449e-8c59-d6377af1ab22",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "263afd44-23f7-4396-87d2-eeb0267be34b",
"company_code": "sample string 5",
"company": {
"id": "4148e196-8b78-48cd-a17d-3b82e4658bba",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-22T17:48:00.4128781+00:00",
"sales_territory_id": "dc039d6f-673b-420d-bef5-0e4ee6984d12",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "785c24b5-473c-44e1-9096-8c526ee13d2a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c1fbce8e-22be-4dd1-9d26-43136aa433aa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7e3f4c03-481c-4662-90ae-6fbb398361d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1800d25a-d0ee-44d2-9a46-48428ed782d1",
"db_currency_id": "838d69ae-4309-4206-af3b-0df3a1f351d1",
"db_language_id": "1185b1c4-80d7-4174-8877-c6fd59ec0890",
"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-02-22T17:48:00.4128781+00:00"
},
"modified_dateutc": "2025-02-22T17:48:00.4128781+00:00"
},
"marketing_segment_id": "9edf315b-3bb8-432b-af89-b1a799ddbbf3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fb3fa485-f8cc-41a8-ad96-4dfc99cf6a3e",
"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": "173c8e75-4925-43c7-b750-b48ec46cc080",
"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": "565aaac1-a8e2-4179-a19b-33b3b1753c22",
"db_country_code": "sample string 28",
"feelist_id": "0ddec221-3c54-49cc-aae5-67253fc0aa62",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c78afcbb-50f0-4e5e-b528-42a3a6b2104d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "be1ebb10-284b-4ff3-b882-6c20f4c74f39",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-22T17:48:00.4128781+00:00",
"db_currency_id": "c3c6c5d6-487d-48a7-ae5b-0897cde87a9c",
"db_currency_code": "sample string 10"
},
"company_type_id": "dddeb150-12b2-45ee-88ea-c8e792daea8e",
"company_type_name": "sample string 32",
"company_type": {
"id": "d49dd86c-fc2e-45bb-aeff-cf789333f0a0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5b606b93-132c-4f75-9634-dc01f9400062",
"sales_organization_code": "sample string 5"
},
"db_language_id": "facb9365-d5a6-4828-9d3f-156cb80ef11f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cc3dfebd-8363-4978-9ac6-5582a54fb7c0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0907ce3a-fb92-4ccd-9333-78751ffeb41c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7974e0fc-27a5-4716-8be2-5426d49c23da",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-22T17:48:00.4128781+00:00"
},
"company_sector_id": "546b0b65-9513-4987-843a-286675991cf3",
"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": "bb3e5281-065c-48ac-aaec-0faa77955dc2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "228df040-14f6-4893-abf3-3ba602a8ac1e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9ad2bc05-43c8-4616-9ce6-77da0fd3166f",
"account_manager_user_code": "sample string 56",
"company_status_id": "ecc2b905-f47d-4e6b-98ec-8cbe70c84d6a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-22T17:48:00.4128781+00:00",
"id2": 60
},
"db_language_id": "fa3ceeb6-74b6-4242-9b71-43ce74a17373",
"db_language_code": "sample string 7",
"db_title_id": "2861e971-1640-4863-8bfb-c05ac8f710a0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-02-22T17:48:00.4128781+00:00",
"create_date": "2025-02-22T17:48:00.4128781+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-02-22T17:48:00.4128781+00:00"
},
"modified_dateutc": "2025-02-22T17:48:00.4128781+00:00",
"id2": 22
}