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": "36e90137-e1ee-4847-8498-431873f5954e",
"_parent_id": "bab56437-6195-48bc-8f51-fa89d6159636",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "51088455-e910-4244-96a3-118e87ef1965",
"company_id": "875cd453-e81a-45e6-9ccc-df90c0e64b00",
"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": "3dd011f8-0c75-499b-b78f-0021b41e99e7",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "39cf66e1-5377-4289-9540-3acc554fc608",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9b60e050-4a96-47e0-9e9d-d9c9f326ec59",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b699e79e-083c-4f0b-af10-ed08643a005a",
"company_code": "sample string 5",
"company": {
"id": "06832577-7074-42df-8c86-4bdbd4b46e95",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-12-21T16:38:55.2201126+00:00",
"sales_territory_id": "8ab12438-baef-4228-96c7-98232b6c1e86",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "257f9a76-34b1-4fd1-85ed-92cd1ffd8979",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "317f3e06-7c34-49be-90d3-8cfcda062bf2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e651ff57-f949-4f5f-8c01-6c32f37c4c30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "55b6f101-b49c-431b-af2a-54f95af9b20c",
"db_currency_id": "9102e7a7-4ac7-4b15-9f0e-3bc71408ed4a",
"db_language_id": "e6fa8641-6e65-44eb-8311-dbed2c5250fd",
"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-12-21T16:38:55.2201126+00:00"
},
"modified_dateutc": "2024-12-21T16:38:55.2201126+00:00"
},
"marketing_segment_id": "1ae7f08e-e58a-4a95-ae83-b9e1fff0960c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "901660af-5a20-4136-8173-e0bb3c03aa06",
"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": "7ce3ad98-a466-402b-92c0-e23a0a0d57f6",
"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": "19a058e1-2b4d-42cd-8061-ce04cbbaf550",
"db_country_code": "sample string 28",
"feelist_id": "90a2f333-ad4d-4b25-99e3-c7b5ed111237",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d151ff47-c283-41f7-9100-39984a7c8e07",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9948c8c6-f2a5-4d9e-bca1-442ed70f2e5e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-12-21T16:38:55.2201126+00:00",
"db_currency_id": "3cb6973c-3934-4156-aa80-28d0c2626fd2",
"db_currency_code": "sample string 10"
},
"company_type_id": "b6032faf-18e0-4bcf-b974-45404e6d15bd",
"company_type_name": "sample string 32",
"company_type": {
"id": "d5b84c0e-6353-4a64-8a11-de00fe41b8f5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "47697587-fa35-47cb-a7cb-e0d972fc6599",
"sales_organization_code": "sample string 5"
},
"db_language_id": "74338271-feb6-43d6-832c-b4a601437ebb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "eed482dc-99f5-4023-9664-372e464f6c8d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ea6a0680-b094-4b34-a51e-6ea7d4ebb709",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "02c93872-e0bc-48c6-b427-09884c989f66",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-12-21T16:38:55.2201126+00:00"
},
"company_sector_id": "605f0afb-8a83-4d5c-b4bc-c758b845d0c9",
"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": "e5c33bc2-c709-4db1-a633-84dd2df8ab7b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b0feb292-ac14-411d-a6b9-e4e9a7b23376",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "46e9d2ed-eeb6-49a4-91dd-7141429eb9b0",
"account_manager_user_code": "sample string 56",
"company_status_id": "6ef1da32-0f6f-43ee-9f64-76f5a30da0dd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-12-21T16:38:55.2201126+00:00",
"id2": 60
},
"db_language_id": "611a4f8b-2b94-4b20-ad9e-e9857ed37756",
"db_language_code": "sample string 7",
"db_title_id": "d87166cf-fe7e-4549-9036-d07abaff922a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-12-21T16:38:55.2201126+00:00",
"create_date": "2024-12-21T16:38:55.2201126+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-12-21T16:38:55.2201126+00:00"
},
"modified_dateutc": "2024-12-21T16:38:55.2201126+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": "bce79681-975b-475d-95ea-14b67a1fc743",
"_parent_id": "3d1869a4-a9bc-4b82-9c9c-2adbaca64ab9",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "7999fc50-d03b-4954-a451-eb483f41a569",
"company_id": "8d90d2e6-667a-44e4-b18e-1af1cb210a72",
"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": "7b500264-fce4-4004-af29-335cb898170c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "be968cb5-cdc3-4730-9310-3edda131c170",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e1a3970c-eb6a-4248-aef9-128145c1a9f5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c5533520-7706-4010-98e0-87b178ed2544",
"company_code": "sample string 5",
"company": {
"id": "fd9c818b-3f06-40e1-9027-741b8448970e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-12-21T16:38:55.2201126+00:00",
"sales_territory_id": "a719d51e-1965-4fde-928b-0ff68bb6ab03",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0a97c7fc-8a46-422d-baaa-b6538af49c09",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1f7b681d-41de-41c1-b63d-5e4f3106ecb8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "be20b659-beb9-4480-96a2-f2730467bf22",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ce6b715-200a-4ef0-b179-9769155f6984",
"db_currency_id": "454275d5-4f1c-4ec9-bc1e-802f582fa8eb",
"db_language_id": "7a17d7fe-fc79-451f-a12a-b9ab84436274",
"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-12-21T16:38:55.2201126+00:00"
},
"modified_dateutc": "2024-12-21T16:38:55.2201126+00:00"
},
"marketing_segment_id": "4b157464-2802-4d9b-b650-439ed6828a0d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7ac05169-dc2f-4054-9ac0-1b927b92f278",
"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": "308f8779-bb16-4963-b099-0229a267beef",
"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": "ac6afd7f-16b8-4955-9e2e-9891394ee79b",
"db_country_code": "sample string 28",
"feelist_id": "0d39f2a1-18b4-4041-80aa-ae2c04b8331f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "73ff77d1-b741-4ed0-ab9a-dd24a44589f6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "51a581d6-b021-496a-9128-763f1dfee4a2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-12-21T16:38:55.2201126+00:00",
"db_currency_id": "6562292b-0a43-4a8e-8cce-6fbd1edb0f91",
"db_currency_code": "sample string 10"
},
"company_type_id": "81ca5be4-a7f0-4ca0-806d-aad9eb59b4bc",
"company_type_name": "sample string 32",
"company_type": {
"id": "40f062f8-888e-484b-8d45-8dd33155da88",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8ee510e1-bc4c-45b7-bea6-3284e054e86b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "eb19718b-582c-47a6-a9cd-bca914d52bef",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7edb6ea1-3d69-47a7-a13f-16f633740a60",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9e641ab7-647a-4143-951e-7db656c14c2d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9a391a86-59f7-41d7-81a1-dfe0b7af658c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-12-21T16:38:55.2201126+00:00"
},
"company_sector_id": "cda4bc43-78ca-4cac-b069-a38c109562f3",
"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": "e91b422f-2aed-48bd-8268-f7915ea87c93",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1e1696ef-a78d-4f1f-927f-722b0945dbb7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1542d939-2692-4ba8-b988-2af0e14d9cf9",
"account_manager_user_code": "sample string 56",
"company_status_id": "5d006af8-44b2-4241-a8a6-84defff1390e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-12-21T16:38:55.2201126+00:00",
"id2": 60
},
"db_language_id": "041ebb27-c245-47b6-bc90-4cec4983b9f2",
"db_language_code": "sample string 7",
"db_title_id": "cffb8b77-1bf2-4372-a236-038758c29aae",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-12-21T16:38:55.2201126+00:00",
"create_date": "2024-12-21T16:38:55.2201126+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-12-21T16:38:55.2201126+00:00"
},
"modified_dateutc": "2024-12-21T16:38:55.2201126+00:00",
"id2": 22
}