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": "fdaa21af-e0ea-4b6a-8a4d-f8f274a496f9",
"_parent_id": "58d5a16c-7032-47ea-91c2-f0519ed85e43",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "3f8e81a3-a4af-45c6-85cc-e491c3206b77",
"company_id": "0c96d06f-dd1d-4277-8283-417e1e7d681c",
"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": "2e42a5a2-589b-4c81-9fe2-2fd4a58fbc0c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "5b14c436-0b76-49da-80b1-580f303682eb",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "91744ee1-235e-4800-8fa9-084e196c5f3c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "416e38cc-c6fc-4a0e-b9f3-2e2509ba220b",
"company_code": "sample string 5",
"company": {
"id": "d4f2ab77-e5c9-43c0-8357-14ce2e5fc05f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2022-12-02T21:33:10.2881349+01:00",
"sales_territory_id": "0729fb61-87d9-4e48-89ed-d1fe588427f2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "46480cec-3eb9-4ca7-8d1b-6bbc92a448d1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ff33333d-d9b5-436e-855b-033040d1fc84",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "37c65a79-617a-4642-82de-9e4e6b7b55b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90e1cc14-aa1d-4755-85de-4b95e12b7cce",
"db_currency_id": "cf6d6dc1-6176-44fd-8a27-68f6f93b336e",
"db_language_id": "fa32f8f0-ec91-4b7d-a7c0-f512c1f070e8",
"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": "2022-12-02T21:33:10.2881349+01:00"
},
"modified_dateutc": "2022-12-02T21:33:10.2881349+01:00"
},
"marketing_segment_id": "dd55851e-0c30-4269-a4e0-b2b343058779",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7194c736-652d-4c7c-9440-545cc11f07b4",
"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": "89627ee8-4bb7-4f08-a57b-f0c83f94802d",
"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": "6f8825eb-8112-4d02-a74b-86153dc69e52",
"db_country_code": "sample string 28",
"feelist_id": "5d0cd5f7-8c83-4e26-8070-c632ba7f7c9b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d6619569-2e4c-476c-9170-ad66f64c5679",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "85228139-da1b-404c-8286-36e914f41463",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2022-12-02T21:33:10.2881349+01:00"
},
"company_type_id": "caa548a6-7baf-4464-bd89-6db6ac49272f",
"company_type_name": "sample string 32",
"company_type": {
"id": "99983c8a-9399-4293-ae64-8a176f410f33",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0f70b38b-4d1c-4cd2-8434-517e89f49674",
"sales_organization_code": "sample string 5"
},
"db_language_id": "95456d1e-cab0-4da5-8f5d-5718391c8353",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "efa6d77d-a8c9-4044-ba28-42bac88bed00",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b973adb1-3f72-4abf-8fd5-e232782d51c6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "be2af62d-5e0a-49dd-abbf-c0646b737263",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2022-12-02T21:33:10.2881349+01:00"
},
"company_sector_id": "0e503944-7d98-4a56-b14b-a9a06be776ff",
"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": "6e416ce7-c5ba-4694-9e36-10913dc6e7b9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8e29c55c-27ac-4b69-8447-09cba8ab4107",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cb07f3b3-db5e-41b2-ac5a-c37178ed2ed6",
"account_manager_user_code": "sample string 56",
"company_status_id": "128d6912-7fb0-45c2-a949-df958903cc80",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2022-12-02T21:33:10.2881349+01:00",
"id2": 60
},
"db_language_id": "ebedfe73-2986-4f08-9da4-e5b650f5587d",
"db_language_code": "sample string 7",
"db_title_id": "375724c3-e46e-4f39-9364-a79e2069e879",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2022-12-02T21:33:10.2881349+01:00",
"create_date": "2022-12-02T21:33:10.2881349+01: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": "2022-12-02T21:33:10.2881349+01:00"
},
"modified_dateutc": "2022-12-02T21:33:10.2881349+01: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": "5725be64-d4da-406d-ab67-a990a8e48272",
"_parent_id": "a7a71c8d-9787-44ca-9ade-6d790510df77",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1753db01-d291-4a0d-8c64-8c006ea2ec52",
"company_id": "6bea88ac-b53e-4321-bf1c-b05e2a5f158a",
"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": "146dd010-6af1-4042-8f01-caf60ef3038c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3e30fb4e-c6ca-4ffd-9c12-9ca8ac4b6768",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "23f30d24-d6bd-4ebc-9695-79c1e1c2d30f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2558187f-f8c0-454f-9908-d7b371df2661",
"company_code": "sample string 5",
"company": {
"id": "a45078b0-37e7-43bc-b2d2-0e8b91b32975",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2022-12-02T21:33:10.3383333+01:00",
"sales_territory_id": "acaefc67-8a5b-4cea-b377-824aafd094ca",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "dc7d8b49-2c48-4f1e-b842-8746e652eb67",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1cb8aa05-d519-40c6-9c79-d2f39353b280",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "45516ddb-3b73-4059-bee0-25f11dc00fff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2bfd2017-1842-42f8-8804-ef88f0141e4a",
"db_currency_id": "8d45ef3b-3eaa-4d68-87a7-4391c4a967b1",
"db_language_id": "8a057135-3f45-4d85-a74a-10a7891a5d6b",
"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": "2022-12-02T21:33:10.3383333+01:00"
},
"modified_dateutc": "2022-12-02T21:33:10.3383333+01:00"
},
"marketing_segment_id": "97506791-f8d4-4439-b523-8309a75a4809",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "62c4eff8-349b-4697-926d-9b8b0879675d",
"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": "3bb7db62-75c7-4bf6-adf9-c27edf107b2b",
"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": "32e19f02-cb8e-47d4-ba14-5165b6875cfb",
"db_country_code": "sample string 28",
"feelist_id": "dea49237-ee81-4976-bbe1-2a038554ee85",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b688c8cd-0372-48c6-8a9e-731af4f4a424",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f21d2546-05d4-41d5-a3b8-5e5d2707ea27",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2022-12-02T21:33:10.3383333+01:00"
},
"company_type_id": "5597f0e8-d720-4cb3-a022-eebd983b1d25",
"company_type_name": "sample string 32",
"company_type": {
"id": "0d769e33-868d-4880-9c54-e66cc70e22a7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3173c076-3923-45e3-a5bf-6a6745b18fef",
"sales_organization_code": "sample string 5"
},
"db_language_id": "86d725c4-dd44-4146-a2aa-9d3e53d951db",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fd472fa1-8b48-4c6b-82ec-c48de500e1eb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c3005e04-c788-4c26-8763-9234bdfb9a16",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d7585a85-c6a9-40be-a05a-a16df8e1642f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2022-12-02T21:33:10.3383333+01:00"
},
"company_sector_id": "fcd8f68f-50cf-4bc9-a3f6-4aab47a24aaf",
"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": "92f1c24b-c4f7-4233-96a4-f4e5821b00ce",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8d783517-7b13-4770-9804-45edcfa5663f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "957569bf-fc7b-4b85-bcba-cbe564abb5fa",
"account_manager_user_code": "sample string 56",
"company_status_id": "1a240820-37e5-4730-bb3c-9c1495cf8f77",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2022-12-02T21:33:10.3383333+01:00",
"id2": 60
},
"db_language_id": "3d550cab-d142-4427-9fd6-4fe8b0e03f3d",
"db_language_code": "sample string 7",
"db_title_id": "e499f668-7bc0-4d31-b93d-20ffcdf28166",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2022-12-02T21:33:10.3383333+01:00",
"create_date": "2022-12-02T21:33:10.3383333+01: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": "2022-12-02T21:33:10.3383333+01:00"
},
"modified_dateutc": "2022-12-02T21:33:10.3383333+01:00",
"id2": 22
}