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": "b46826f3-88b6-43ab-9d23-aa8b912611b7",
"_parent_id": "eb3a2630-95f0-40fe-9dca-8a8737ea900a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "03cc49e2-fd89-4985-9545-110677155846",
"company_id": "15375fb2-1249-441b-862e-12caa5da999b",
"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": "5844c251-7783-47e5-92c7-6aafcc1c3380",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "eca1ed4b-3194-4f5f-847a-65328d749357",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "1262b55d-d6ac-475a-97a6-3a7d867536a8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3ba05b2e-d8b6-4fca-a1bf-24327b4a40a6",
"company_code": "sample string 5",
"company": {
"id": "7debe69a-cb65-4dc0-958d-c2147fcd689c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-04-25T05:38:26.3970448+00:00",
"sales_territory_id": "4d3541c2-fc84-49fb-8fed-fa56b96dc8f9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2e4aead1-c52f-404a-a382-ce45b53fdc5b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5e9ca4e5-2f66-4851-b470-d9fc50b10a4e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d67dfcd1-8472-48d7-a53c-6ad9008da4ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5e35afc-f4cf-4145-816a-f5b2e38512de",
"db_currency_id": "55990bc9-a7a4-47dc-ae69-c0d55ee83641",
"db_language_id": "047a3d27-1801-4f72-aa94-ff819642981d",
"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-04-25T05:38:26.3970448+00:00"
},
"modified_dateutc": "2024-04-25T05:38:26.3970448+00:00"
},
"marketing_segment_id": "11d23342-322a-4c88-a91b-8f24f1030f0c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "46591910-5f40-467c-98ee-49ce98fdbd15",
"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": "ac695121-2dc2-46d6-af57-861e24adead7",
"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": "458e23ca-047f-4192-8f7a-4af8bc5593b2",
"db_country_code": "sample string 28",
"feelist_id": "04403556-ef38-4840-b481-add8ba31df20",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1205a7cc-8d76-465c-bc58-8672020bfbf9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "67f69d1f-cdcb-4042-a245-ef84df9bcfd7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-04-25T05:38:26.3970448+00:00",
"db_currency_id": "ab076650-8bb5-4554-bea6-88b7b4f11562",
"db_currency_code": "sample string 10"
},
"company_type_id": "97e9532f-2260-4432-8e5f-276ed5b3c68f",
"company_type_name": "sample string 32",
"company_type": {
"id": "165b495b-c3d2-4174-bff8-307443c56bdf",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "85de0131-0fa9-4cb2-9129-c71c903a8739",
"sales_organization_code": "sample string 5"
},
"db_language_id": "df675f33-b465-4bcb-85af-79349d594933",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b7c00720-bd5f-48af-8869-8992d7ca9fa8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "63df0f7f-7a3b-4fcc-ae2e-14dd89c3e0c0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "43ca4bc2-16d3-489e-bacb-3054dc1cad33",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-04-25T05:38:26.3970448+00:00"
},
"company_sector_id": "5ffb089f-2898-4f62-b558-083dd0b77990",
"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": "cbf738ff-214f-4a9f-bab9-30ca51f859d6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "78b7c627-4eb1-4323-aee0-f493d7e36aa4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "63073961-8395-4efa-87de-e9a0530f4453",
"account_manager_user_code": "sample string 56",
"company_status_id": "3d4613af-74bf-4378-b470-42af96ca4043",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-04-25T05:38:26.3970448+00:00",
"id2": 60
},
"db_language_id": "23ada391-06cf-45ad-bf35-386a1593e807",
"db_language_code": "sample string 7",
"db_title_id": "d9ea40d0-77c5-4157-b983-c3ff71cc89a1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-04-25T05:38:26.3970448+00:00",
"create_date": "2024-04-25T05:38:26.3970448+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-04-25T05:38:26.3970448+00:00"
},
"modified_dateutc": "2024-04-25T05:38:26.3970448+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": "29aeb844-a9b8-49ec-b7fa-6725a2251c25",
"_parent_id": "70d8d0a8-7d21-4b78-b896-d46262113129",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "13f4ef1b-d2e0-4db8-9b09-e99eaefa2b67",
"company_id": "20f8cd7a-6f81-4c27-a4dc-e5f1c39438fc",
"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": "62b5f378-49d9-47ab-bbe2-6e6933332401",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f7cff227-3b62-413d-b1b5-0edbb20c0b53",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "09b7c055-e4cb-4b5f-8cee-7fea9b23b60a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "596e2cb7-e44c-41bb-8b0e-ad239124495c",
"company_code": "sample string 5",
"company": {
"id": "d61ce3d5-aa6f-430a-9404-033f0fa113d7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-04-25T05:38:26.3970448+00:00",
"sales_territory_id": "69ba105a-f7bd-443e-bc2f-c7b21d311ac2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e91eeb8c-3049-47ff-92e2-b9f85ce68e1a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a7815da2-8e6c-4236-90bf-5b93a7cd750c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c1925bd5-fb81-444a-9bff-d3d9222c25a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73deae9e-db28-4b1c-8a98-5848af000066",
"db_currency_id": "db26dff9-8cef-4f6e-bff8-4a4a7369b500",
"db_language_id": "59ce30c2-f67b-4e25-9aaf-5dc212df76c2",
"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-04-25T05:38:26.3970448+00:00"
},
"modified_dateutc": "2024-04-25T05:38:26.3970448+00:00"
},
"marketing_segment_id": "e204c299-bc73-4dda-80c5-85359ac7a3e6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "79fc6cad-d46c-4225-b64d-904b70aca0ae",
"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": "2c42b5f2-c993-47fc-9ca3-19a90b4448c9",
"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": "39f73ddb-bfa8-44da-a3d4-dca9f1f18f8e",
"db_country_code": "sample string 28",
"feelist_id": "caeb9d94-f5e3-4c29-ac3a-8897db183555",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "026ea745-adf7-4ce4-86c2-c841ec12ad68",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "13f2126f-d45c-42aa-bb40-8c290dac366a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-04-25T05:38:26.3970448+00:00",
"db_currency_id": "8758df1d-78d7-4665-9271-73b79977ff7d",
"db_currency_code": "sample string 10"
},
"company_type_id": "3fbef6ba-bc27-42cf-a5de-ed0a44f80222",
"company_type_name": "sample string 32",
"company_type": {
"id": "49ccdce7-2357-46f6-b829-af2e44d8ec81",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8d0d1a5e-ae09-4058-a854-360bb5ba7174",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9dc691c1-6967-43c6-bbfe-14ea597840e8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "32ab7411-899d-4c7b-9d04-34456dd9e537",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "136feaff-1f86-4b34-844d-c5887a24f7ba",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9c09e652-2bea-46a4-bf77-91c2b6efc3ca",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-04-25T05:38:26.3970448+00:00"
},
"company_sector_id": "c28a1f51-3937-4d2b-a101-ebde746f0d96",
"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": "89bca5e0-13b2-4455-8402-0255dff1cbf0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4a299308-c766-419f-a986-f57e574fef72",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "72c380f5-b06d-4c80-a7db-e60382f6fd84",
"account_manager_user_code": "sample string 56",
"company_status_id": "b8d1ac99-80db-4811-a323-8e4149baf7e1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-04-25T05:38:26.3970448+00:00",
"id2": 60
},
"db_language_id": "4f40d643-f285-4084-b695-2c3deabc0905",
"db_language_code": "sample string 7",
"db_title_id": "8c740ed6-ddb2-4853-a161-14e2724e25fb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-04-25T05:38:26.3970448+00:00",
"create_date": "2024-04-25T05:38:26.3970448+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-04-25T05:38:26.3970448+00:00"
},
"modified_dateutc": "2024-04-25T05:38:26.3970448+00:00",
"id2": 22
}