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": "12b3cf73-a9bf-455e-a70c-970d4c02337e",
"_parent_id": "449d28b2-bd87-4d61-a8e4-a5961815a682",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "01ecf21a-dbaa-4cbe-877b-ab374e7e4151",
"company_id": "fcb9e1e2-bd66-4010-81d3-18c3f4e8fff5",
"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": "7c4c24aa-992f-4ba2-aba9-93d7abb2d96f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "16d02470-a5b1-4404-8874-b647d34e4e24",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "fb5e9ee0-4659-460c-bb97-cf9e522bedde",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "56161505-8702-4a7c-aab6-e401f1fd5ce5",
"company_code": "sample string 5",
"company": {
"id": "2d938ab7-58da-4ab9-9340-d6198a35a55a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-03-21T14:40:58.3096449+00:00",
"sales_territory_id": "4f61c7f5-cc14-4762-96c2-8cc7b8f12f51",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0a357d22-f0a9-4b22-b78d-b3e0814dea86",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0a73e6c7-d03d-487a-87e5-5c81228320fc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3070a79b-8a86-4b23-9a95-5f2fe4530955",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1519fbdb-424f-43d4-a065-aa12a5d4ce01",
"db_currency_id": "38b5a2c5-d595-492d-adc2-a3bbe26de54f",
"db_language_id": "d9985347-e909-4625-9dfd-2fa7ed67ca5b",
"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": "2023-03-21T14:40:58.3096449+00:00"
},
"modified_dateutc": "2023-03-21T14:40:58.3096449+00:00"
},
"marketing_segment_id": "08af7566-004a-4cfb-b1db-7dc64c669237",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "158b67a8-d748-4b6d-b0d9-7eedafac3258",
"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": "dc176525-a459-48db-8c6a-cb804cd21ee3",
"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": "8233714c-b9a1-482f-988a-a9ed98b4fca3",
"db_country_code": "sample string 28",
"feelist_id": "77342a3e-e968-4636-9791-d582cd0361a4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "47237e61-3625-42c9-9871-3ce92a074b8f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e145cea1-5b62-4fa0-9c9d-66ad388d464a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-03-21T14:40:58.3096449+00:00"
},
"company_type_id": "4bc8a25b-cbce-401e-897e-1ad9396dd6a6",
"company_type_name": "sample string 32",
"company_type": {
"id": "763b2b92-cbf8-4b90-8bb8-81b7fa924ca5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a21781b0-e150-4498-be9b-0b51bb1910d4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e89b24da-bb7c-49b6-b03c-80fd75cf6134",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e0d1dcef-3375-4254-8ffe-c385bc4bcc40",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "887232e5-b30f-4c90-8472-4399a259576f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0a4c86a2-f0fc-4d1c-a848-a276d3f1d778",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-03-21T14:40:58.3096449+00:00"
},
"company_sector_id": "5c7f1b9d-7ec2-47da-8f84-d1df30cf5f1a",
"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": "dc25912c-8087-4ae4-a172-0cfeb2cd180d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "aec5048f-4ddc-467e-a04a-e2e98b907f40",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "29d32b2d-e980-4d93-a5b8-d11356f58def",
"account_manager_user_code": "sample string 56",
"company_status_id": "676dafc9-1849-4364-adfd-c91229ca4d28",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-03-21T14:40:58.3096449+00:00",
"id2": 60
},
"db_language_id": "67532e7c-5832-4a4c-b0cf-1fb88a427b59",
"db_language_code": "sample string 7",
"db_title_id": "4533d057-cf67-40be-9c44-0b8f39b1bd4d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-03-21T14:40:58.3096449+00:00",
"create_date": "2023-03-21T14:40:58.3096449+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": "2023-03-21T14:40:58.3096449+00:00"
},
"modified_dateutc": "2023-03-21T14:40:58.3096449+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": "86b2171b-b4f2-4739-b11b-aceab0836c17",
"_parent_id": "9d14ab66-66ff-42e0-9391-4c388513e68a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "cd392d1d-bda6-4172-96a8-ce449456947e",
"company_id": "e7ace781-05c3-4647-91eb-e1fd6f316c9e",
"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": "872a6eeb-198b-4dff-b40f-1d8944079c50",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e8c831be-0660-4a26-83b4-877afcbdae85",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "611bc973-52fe-45b8-aca8-be5c140a3831",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5396ea9d-d45d-413f-a208-102bf97dca02",
"company_code": "sample string 5",
"company": {
"id": "9c3ef0c0-0eb1-48a0-b341-30ea3bbca290",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-03-21T14:40:58.3096449+00:00",
"sales_territory_id": "7a9bb9a8-ec32-4d05-8e47-a1531c680428",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "44c33819-7d32-46f9-a6e1-d65917286d6d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c8e09438-31f3-4082-b2a1-8ada32c1e697",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2e0f0c49-e2b7-4177-8962-d0ac26dbb16c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bdae44ed-d952-4ccc-92d0-da4c1318c626",
"db_currency_id": "f8b32fce-4476-4873-b283-84e62ef7539e",
"db_language_id": "de6bfed1-2f8d-4bad-a2ec-96fc3eefa150",
"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": "2023-03-21T14:40:58.3096449+00:00"
},
"modified_dateutc": "2023-03-21T14:40:58.3096449+00:00"
},
"marketing_segment_id": "cca84c65-0c49-4060-8bd7-76040cfd8cf3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "435a76f8-0180-4b60-bb43-19b20bc5dca6",
"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": "92a43dfd-6ba9-4e96-9a5d-15f4c71349aa",
"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": "3c08bf7a-6287-4874-8695-c48b5f151d3d",
"db_country_code": "sample string 28",
"feelist_id": "7d64a0e3-05b8-4283-8c4d-42cf27966bd5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "99a40b04-62a3-4ff0-9854-7285d32d9905",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5ab37276-4db6-4f21-83b3-8e451425ad1a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-03-21T14:40:58.3096449+00:00"
},
"company_type_id": "6a7cb2a1-1eb5-4869-875d-460ece468dfa",
"company_type_name": "sample string 32",
"company_type": {
"id": "38e252c7-77ad-418b-b051-c74214617784",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "382177da-5881-438a-9787-1f163ebe5869",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1c615e83-2814-4fef-865a-074ccb1bf252",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0d8aad12-1e44-404f-8a8b-13c19a222495",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2c1d74da-cf4a-4e96-9df9-ec74b8605dcf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7d3dfc92-557a-4b93-8e40-1b993a491d66",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-03-21T14:40:58.3096449+00:00"
},
"company_sector_id": "035ff161-c2b7-49a4-b0c5-2dc41b94d5aa",
"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": "026985e5-5ad0-470e-9aad-bb79f4208910",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b9b31292-cc1c-47c7-8010-0149b84ad733",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a03f703d-0d3d-46b5-b4aa-7c8c68ace6a1",
"account_manager_user_code": "sample string 56",
"company_status_id": "a406ff11-d5a4-4649-b5db-dcef09304d45",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-03-21T14:40:58.3096449+00:00",
"id2": 60
},
"db_language_id": "bb1ecf08-4114-4d11-af74-452a7bea97d8",
"db_language_code": "sample string 7",
"db_title_id": "acf73a97-bffd-4344-baa5-3f318b220c7f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-03-21T14:40:58.3096449+00:00",
"create_date": "2023-03-21T14:40:58.3096449+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": "2023-03-21T14:40:58.3096449+00:00"
},
"modified_dateutc": "2023-03-21T14:40:58.3096449+00:00",
"id2": 22
}