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": "d272ec66-4506-4598-9749-b96df89459b8",
"_parent_id": "015f7b73-69aa-45ed-b9b8-fff6de1227fd",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2ad4f9e5-e7c9-4ae7-947f-005e89d1d748",
"company_id": "f91cad54-53b1-49bf-8b42-465ed3083f04",
"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": "3c9ad394-e76a-476d-9ffe-614596391cb8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "1a366586-faed-4871-bfb0-4f03e444de96",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "43b48c1c-eb25-442e-99a2-9fc3d06a2c6c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "53d1c804-c251-40d7-b346-64afe4564f1d",
"company_code": "sample string 5",
"company": {
"id": "91eed199-dbd4-4e60-a981-48b9859c01ef",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-11-21T10:11:44.5291501+00:00",
"sales_territory_id": "dca558fb-d201-4696-8692-7f98cfe01993",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0fe2796a-ac8a-4161-a8ec-7b0b53f6e36c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "98d0d006-4564-4a9a-ae8c-183d688507f3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d0a313b1-4198-474b-a82e-35834393cb33",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58399b47-a314-432e-9ec5-315896126b0f",
"db_currency_id": "41723ffd-f6c5-41ae-8adf-f14c9943e9c7",
"db_language_id": "c41ee41c-0f40-41ba-8458-a91e835ed785",
"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": "2024-11-21T10:11:44.5291501+00:00"
},
"modified_dateutc": "2024-11-21T10:11:44.5291501+00:00"
},
"marketing_segment_id": "77087c1f-dc5d-414f-bed6-561891509cb3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "994627b8-48f4-4643-8d45-2edaa77d2265",
"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": "d1841ef8-c565-4577-8e11-88d61d617fd7",
"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": "410de71b-dfe0-450b-a9d6-7c1d422ad9ac",
"db_country_code": "sample string 28",
"feelist_id": "6ea8d080-a044-49ee-9c7e-7dad98c6252c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "31df80cb-4baa-4d65-9d17-145abb764f77",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "74767ac9-60fb-46d7-bd2f-e504cd7e887e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-11-21T10:11:44.5291501+00:00",
"db_currency_id": "c1170d36-635c-444b-93ff-7475b199a014",
"db_currency_code": "sample string 10"
},
"company_type_id": "72202432-e0ae-4225-b87e-05bb6054f705",
"company_type_name": "sample string 32",
"company_type": {
"id": "27cd9b77-a4b9-449e-815f-26875d98b438",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a536f6e2-2fb9-4a3f-917e-7c3243f3be5e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f6f956f5-7b86-45b4-b210-7ee86e4bef90",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "28c8a34d-9c51-4de4-ba2e-34fcf81c67eb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c455ca43-cb59-44de-92e1-c1b1724e03a1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ac7fffbb-43b0-4e94-880b-5d9640bf6d25",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-11-21T10:11:44.5291501+00:00"
},
"company_sector_id": "9b4f9919-1705-4c88-b39b-ee9ea1f0529c",
"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": "17afb147-f45e-485e-840f-5aaf91b4d6e1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7f1cd191-b530-4942-a4d3-640dc31de940",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "98a9d506-c8e8-4eb5-94a3-5830e4e1dae2",
"account_manager_user_code": "sample string 56",
"company_status_id": "11250056-35f4-47ff-ad06-fe63b84bb550",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-11-21T10:11:44.5291501+00:00",
"id2": 60
},
"db_language_id": "61d6eda5-3704-439b-ae8a-ce9413856fa9",
"db_language_code": "sample string 7",
"db_title_id": "92ba742e-00b0-48ad-bce6-ede3c3a5422a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-11-21T10:11:44.5291501+00:00",
"create_date": "2024-11-21T10:11:44.5291501+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": "2024-11-21T10:11:44.5291501+00:00"
},
"modified_dateutc": "2024-11-21T10:11:44.5291501+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": "2e7e6c2f-3b07-4675-b56d-774b1762a2c7",
"_parent_id": "80002a68-94c9-4df4-9847-51c1b124e55f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2a97ef75-37be-49ec-bfa4-231755ac62d2",
"company_id": "f0f95912-dc0e-4532-a092-b1a7553c1266",
"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": "34ee7c3d-caaa-436a-84a5-b6e0b87baf16",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "7b45e22b-3972-4e04-918d-8ae2d09a87cf",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "cec54c7b-792a-4886-8424-21fd23a7bcb1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "91a30d80-9432-4253-99a7-5c7fd3122105",
"company_code": "sample string 5",
"company": {
"id": "6e50bed6-4653-4847-ad47-891fca5f46d0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-11-21T10:11:44.5291501+00:00",
"sales_territory_id": "90271277-e4e9-4800-acba-76db83eafe97",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "86dbcfce-1a75-498a-a895-42d0fe1d8de8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2e1e7dad-b546-42f2-b217-94aba181d9b0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7b67417d-8845-445e-9c85-71c0857136eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "795c3a1e-285b-4b9b-95a3-4912f384b3e0",
"db_currency_id": "06589f4e-d9bf-46d7-9374-33be0bff2526",
"db_language_id": "2a9c21e8-9df2-4ef1-b8fd-8c23bb16c480",
"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": "2024-11-21T10:11:44.5291501+00:00"
},
"modified_dateutc": "2024-11-21T10:11:44.5291501+00:00"
},
"marketing_segment_id": "4e0e9e62-a4c3-45f8-af6f-355042097777",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "078f60fa-da1f-4a48-b8e1-b8a4f14326cc",
"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": "432893ca-fbdd-4c55-a641-c885dd02bd47",
"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": "39d854bc-4c1b-4197-ac29-59259cbdc1dd",
"db_country_code": "sample string 28",
"feelist_id": "047be5a3-2ec2-444c-80f0-78e9f6d10fcc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9e015130-8b25-43dd-87cf-47271977cad8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "236d7e2f-bffe-431c-bd4c-f2e568280fb1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-11-21T10:11:44.5291501+00:00",
"db_currency_id": "e90c49d1-7e19-4f5e-a736-52ec6ae1f271",
"db_currency_code": "sample string 10"
},
"company_type_id": "1a855075-a23f-40a2-b5d8-ff0f8f3e675e",
"company_type_name": "sample string 32",
"company_type": {
"id": "d5af4073-0d84-4065-867d-82a3615aa027",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "14e6742c-eec5-4ab9-8e6b-eaee6e63c7b3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9fc38697-e401-445c-a7d5-a525625aa362",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "10496cc5-f35d-4d15-83fd-448f5dfc7170",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "06ec1290-b07f-44db-831f-5db9fb16db66",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7913d04c-ecba-4e43-9086-a024fe3549fe",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-11-21T10:11:44.5291501+00:00"
},
"company_sector_id": "849c764d-ec83-4e65-a40f-b49382dbbe4c",
"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": "4d7b23fa-8f1f-400c-b683-c88a81b924f1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "606451e3-36f3-4196-a83f-f05393d76adb",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2c87fd08-8d57-4690-abdf-3582b8d60190",
"account_manager_user_code": "sample string 56",
"company_status_id": "16c4de63-ddc8-48c3-873f-3789d9598bf6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-11-21T10:11:44.5291501+00:00",
"id2": 60
},
"db_language_id": "31cd241c-aebb-4df4-8795-7595e8af59ae",
"db_language_code": "sample string 7",
"db_title_id": "025cbeff-b83c-4bdb-9f23-899d29b43ab3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-11-21T10:11:44.5291501+00:00",
"create_date": "2024-11-21T10:11:44.5291501+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": "2024-11-21T10:11:44.5291501+00:00"
},
"modified_dateutc": "2024-11-21T10:11:44.5291501+00:00",
"id2": 22
}