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": "2e39238b-d8cb-42ae-8bc5-462581b0c8e6",
"_parent_id": "4e36c85c-bcc1-4d45-a5dd-b71e08a1b523",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "af8f7fde-a34b-4ba5-937e-fdb8de77079c",
"company_id": "0bceba46-c976-4492-98a3-a19cc2c8bbb1",
"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": "0b1dbdab-c169-497c-b412-aae0f9400e2c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "070ba4b9-3525-4378-9c04-86b42ebd0d6f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "67bf9dbd-1f49-4505-b6f9-f986dd7d09a1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "86e7be55-f349-40f4-b3d5-1c59f50d99c9",
"company_code": "sample string 5",
"company": {
"id": "7035a0ef-8da0-4638-ac38-394a2bad355f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-04-19T08:20:14.7557005+00:00",
"sales_territory_id": "55ab4269-edb7-4bec-b684-3a51cac18434",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8fa3f374-2e15-4e77-acb7-e110f3a62c39",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e9e31ff4-64b9-4199-9d87-2787604c4f3f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "78b7e7fb-8503-4709-b30c-dc4453c5e4d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "333e973c-cc31-4d62-a8ad-3507d7b1eb1f",
"db_currency_id": "f8d1257e-3118-4776-b4bc-a624baad47fc",
"db_language_id": "3826c91d-013c-4f4e-8334-6721befceb63",
"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-19T08:20:14.7557005+00:00"
},
"modified_dateutc": "2024-04-19T08:20:14.7557005+00:00"
},
"marketing_segment_id": "d0128a3b-9f7f-4ee0-b883-3880eff5b4e5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "20585552-e79e-4b8f-ba10-af5311ef352c",
"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": "455263a7-ff2a-483c-a21f-3df8dd506d9f",
"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": "029b9a08-6274-45f0-bb00-874f5ed89db9",
"db_country_code": "sample string 28",
"feelist_id": "f672f45f-4f32-454b-98e3-51d3b979c721",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3ac40760-5bcb-4367-a0f7-5abd9d01d610",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d7d80b61-fb27-444c-8132-92731b2b23f5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-04-19T08:20:14.7557005+00:00",
"db_currency_id": "6ca4f651-8b50-4d87-b70e-76d427c89be4",
"db_currency_code": "sample string 10"
},
"company_type_id": "fa80f2bd-eaf5-4a9c-b6e6-74deea7b4bf4",
"company_type_name": "sample string 32",
"company_type": {
"id": "971d66e5-c3b0-4649-ba2d-2609eca171b8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6358d076-f0d4-4bdd-ba41-80fd33b83a00",
"sales_organization_code": "sample string 5"
},
"db_language_id": "562270e2-cd71-46d8-8614-1a43eb31e3a6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "93826030-5484-4b69-8f5a-7a39f1f7a8fd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a4c5815c-9d71-41eb-91eb-6f649ef5a80e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e09f818a-43f4-467b-84cc-e278cf4acced",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-04-19T08:20:14.7557005+00:00"
},
"company_sector_id": "8d3a6c16-84d2-4b47-bfab-2098ecc9d6dd",
"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": "7bcb31c4-bec0-43d6-b3ce-1e0209033204",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "20358286-3f89-422d-8668-46687888d264",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7e03c48d-5290-4fe9-bfb3-668f90269568",
"account_manager_user_code": "sample string 56",
"company_status_id": "116ab91c-28c0-4d1b-aab4-14f2e7344bee",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-04-19T08:20:14.7557005+00:00",
"id2": 60
},
"db_language_id": "8f345325-a841-423f-a228-aaca4a8b70c3",
"db_language_code": "sample string 7",
"db_title_id": "ec381edf-127c-4b9c-b34f-062c85243bc2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-04-19T08:20:14.7557005+00:00",
"create_date": "2024-04-19T08:20:14.7557005+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-19T08:20:14.7557005+00:00"
},
"modified_dateutc": "2024-04-19T08:20:14.7557005+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": "695c5577-9cd4-41b1-afd5-32d4da0d00a6",
"_parent_id": "6b6bf9f9-b7cd-4a90-87a4-279bd6e32fbc",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "5b70ac9d-e18e-4ecf-a391-bcf9a6254e2a",
"company_id": "d2a44383-e089-4a0f-a7ad-681e0f51773c",
"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": "9d188585-2171-4305-8f6e-a815485e814e",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ddc5b0d5-4341-46ef-96db-d2bec6aef6ef",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a9a662ab-8298-45c8-84ee-8eefd28d0ec7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bb876fff-b58c-4e7e-9f28-ed2702cde030",
"company_code": "sample string 5",
"company": {
"id": "135379e8-91ab-464d-8e26-239b57b08099",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-04-19T08:20:14.7557005+00:00",
"sales_territory_id": "57b08034-bb94-4f91-8fa9-704793bd974e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b5e7c058-8a40-4a51-9c3d-e8fbfb38a152",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f621776c-949c-4513-a464-96d362a9878f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5a552ea3-6556-401f-9fc3-a2ad3c62d8d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ec557cf-0128-44da-a7e8-665a01b87453",
"db_currency_id": "936afc47-73e1-4c02-aa43-105a3e103495",
"db_language_id": "d474756b-605f-402c-b1fa-8bdb5d4955c7",
"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-19T08:20:14.7557005+00:00"
},
"modified_dateutc": "2024-04-19T08:20:14.7557005+00:00"
},
"marketing_segment_id": "9ca988ff-3561-49e5-8a5a-3841e75b4fd5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d66850dc-2f48-491e-aa6b-e132df07d314",
"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": "c7347f6b-2525-4e7f-b2c8-2f681996ba77",
"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": "613820d2-6520-4c02-ac69-729bf2a3b3df",
"db_country_code": "sample string 28",
"feelist_id": "b4802893-a0f3-4458-a140-6caec6e08fed",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "683a7435-7138-4db0-a09c-e86335f2dc3f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1d08d988-b06c-4571-9714-cd0cea84a371",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-04-19T08:20:14.7557005+00:00",
"db_currency_id": "5174e08c-a7f1-4704-80e3-ef3d50dd8a86",
"db_currency_code": "sample string 10"
},
"company_type_id": "6cb321cf-a0d8-4841-a9f3-57fd0b078216",
"company_type_name": "sample string 32",
"company_type": {
"id": "503de3cd-492d-4234-8b52-54da5e681d1c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "07046808-9484-4e90-9f30-a3363dcb93ca",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6bcba8c5-0ceb-4e36-90e8-eaa1e210b313",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "75c036ab-7dc5-4a5d-8dbb-dc90b9dbe541",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5c4e15e2-c79e-4432-aab3-6e69ac067823",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e5673b9a-eba3-43f2-9a93-602d59adccaf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-04-19T08:20:14.7557005+00:00"
},
"company_sector_id": "519f8c53-4157-4583-9c80-6846a6b71692",
"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": "28f1fa0b-dbf2-4fc8-b22d-49bfbbc68091",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "219d2470-b90f-42d8-b13c-8fe2a4e198e1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f0881687-7c45-4435-9a59-e4c60fbb0181",
"account_manager_user_code": "sample string 56",
"company_status_id": "427d932a-d129-4784-b2f9-a961ec1e17f5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-04-19T08:20:14.7557005+00:00",
"id2": 60
},
"db_language_id": "ffcfa6cb-87c7-42a4-bcde-fd290f18a9e4",
"db_language_code": "sample string 7",
"db_title_id": "65921425-4064-405e-9ea9-c7773e7bed4c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-04-19T08:20:14.7557005+00:00",
"create_date": "2024-04-19T08:20:14.7557005+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-19T08:20:14.7557005+00:00"
},
"modified_dateutc": "2024-04-19T08:20:14.7557005+00:00",
"id2": 22
}