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": "f1759a28-84fd-4cd2-897d-f9c709e9a920",
"_parent_id": "2a53fadb-408c-40a1-b50c-031c45471a08",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "53b63931-0a18-4090-9e07-04a17155c55d",
"company_id": "19b668dd-76c3-484e-85f5-baf58f223ea7",
"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": "0e010eec-c016-4d1c-addd-b6a737bf7d60",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e6baa022-4ed6-4f0b-8370-c2b0306d7622",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "56bbec46-4c14-4344-bb92-ca8e7c2e31b6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0449d32a-2dd2-4bd8-ae29-99e59f22bd8f",
"company_code": "sample string 5",
"company": {
"id": "16fbaf26-bc27-480d-bc67-4a88603cd8ed",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-01-20T13:13:55.6478604+00:00",
"sales_territory_id": "f510a99d-7e14-42e6-b4ec-fce18665c330",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "22a0d82d-b269-41ca-9a95-8e04010b2b4b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "66fa6e68-0e5d-4b7e-aa56-bd103e746c62",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "21e8fd15-d66d-48a8-b37a-d7f00ca73d35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "33b7dc21-5620-4690-add1-081a251359f4",
"db_currency_id": "22c1aa28-13af-42b3-af8c-64b3e8de5d64",
"db_language_id": "6fd94419-53ba-4374-bc1d-93e878461074",
"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": "2025-01-20T13:13:55.6478604+00:00"
},
"modified_dateutc": "2025-01-20T13:13:55.6478604+00:00"
},
"marketing_segment_id": "4e84b531-d33e-4d8b-a76e-7c24e7e3aab0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "01c664a5-e402-4fa4-bc83-9f6d76138370",
"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": "584d93b4-387a-43bc-adf3-81576185faa8",
"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": "f1223f30-4c71-42a3-a676-016a20bf4876",
"db_country_code": "sample string 28",
"feelist_id": "6c1db8af-2f7e-4e28-a61d-cf4b7aae5939",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4fe457c6-8f9a-4e32-9c6b-e1c59a14e75f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b8303456-4bde-49cc-b90f-75d538522c3f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-01-20T13:13:55.6478604+00:00",
"db_currency_id": "3dea710b-0a5d-4922-961b-19dc72d7dc84",
"db_currency_code": "sample string 10"
},
"company_type_id": "3385f72b-832b-414d-996b-4b4a773311c8",
"company_type_name": "sample string 32",
"company_type": {
"id": "5ffc2b19-8fca-4b22-a400-9d7793c71a4c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2860c5ca-cff1-490f-a940-e393c63abdb3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a7af7ff4-afac-434d-9ef3-34b1744a20ea",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ca2d2a0c-a15c-435c-a806-a3b78a38412b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0425e64f-cb7f-4a28-ad4a-ea48e0316672",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f7e1013f-61b0-4925-9959-faa835cd12a8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-01-20T13:13:55.6478604+00:00"
},
"company_sector_id": "2aed9379-f8a2-4207-a042-0d21965a8416",
"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": "c4edd3a8-0381-44f3-91e6-65842577423e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ae7cdb4a-c8a2-42be-b61d-8f8c03023da6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d848f1fe-b9ac-4c60-a09f-dc212e5fa2d7",
"account_manager_user_code": "sample string 56",
"company_status_id": "563b1a59-4716-450f-b425-1e1fed43666b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-01-20T13:13:55.6478604+00:00",
"id2": 60
},
"db_language_id": "ba87c72a-a14e-4fd0-b088-93bdb20dc591",
"db_language_code": "sample string 7",
"db_title_id": "d24f1917-bae0-4074-a39a-7606502d0079",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-01-20T13:13:55.6478604+00:00",
"create_date": "2025-01-20T13:13:55.6478604+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": "2025-01-20T13:13:55.6478604+00:00"
},
"modified_dateutc": "2025-01-20T13:13:55.6478604+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": "e4d928f3-5646-4d55-9608-83b315fe8263",
"_parent_id": "d168ec23-bff7-4c4b-8340-8f2c2f033e41",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f07571af-c684-49f7-a5a9-210d994f3917",
"company_id": "e8f534df-dda1-4c7d-8442-21994cc3ab3d",
"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": "674a9070-e151-4cfc-9372-4c3b75657578",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "9eaf628e-532f-41ad-af32-b966be72a43f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2f738bec-d22a-4357-9d49-51bf14e8f969",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9e7f26ae-8830-49f9-aba1-8d5a3c7b4677",
"company_code": "sample string 5",
"company": {
"id": "99acb70e-7d63-4fb9-b8ba-ffef1d0f257b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-01-20T13:13:55.7103598+00:00",
"sales_territory_id": "3be4c209-0728-4ccd-aaed-f5004344e2e3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fb97a793-ac80-42d8-b10d-214ff2054ba5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "87aac397-281a-49c2-b492-c970e2532364",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "57ce2532-b5b8-435d-843e-b79166d643e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6cd88d1-15c0-42d2-a840-4f48764cf88c",
"db_currency_id": "5a759267-358d-4459-b61e-18666321f545",
"db_language_id": "41609739-f4f2-40d5-a085-431cc116e862",
"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": "2025-01-20T13:13:55.7103598+00:00"
},
"modified_dateutc": "2025-01-20T13:13:55.7103598+00:00"
},
"marketing_segment_id": "8b2bce93-d506-4692-bdba-e1bedbc0a9c6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6a6b6957-3c34-4ab2-96aa-db9b3f4bd3d7",
"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": "2182ae89-34cb-410d-84df-1fea72afc964",
"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": "f92b766c-cd50-4221-98f3-7b2dcb35fcb4",
"db_country_code": "sample string 28",
"feelist_id": "2e607d88-509a-4ddc-b687-782f3774650b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ee5cd35b-7e92-4777-ae2f-550e31538485",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "56037e00-0dbd-49ae-b546-992ee704b245",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-01-20T13:13:55.7103598+00:00",
"db_currency_id": "10e257ef-3b14-4c4a-886b-6edadee6f7a7",
"db_currency_code": "sample string 10"
},
"company_type_id": "2b0c0602-f4f4-4a00-85fe-a3540e07c049",
"company_type_name": "sample string 32",
"company_type": {
"id": "edbe9c17-f5fd-4eda-919c-a7ca765537cb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e2e009c9-cf12-4564-abdf-ced358b732a5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c91abb3e-b60f-43bc-827a-1afb45e09eed",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4f1e2a41-05eb-40d2-b6ea-2b7d4c42de31",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5ae93a3b-3faf-47be-ab26-58f140b966d1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "532f0ab2-9a9a-4996-a66e-36f487465b73",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-01-20T13:13:55.7103598+00:00"
},
"company_sector_id": "ee5c9302-6a4c-46f9-b07e-66f152f20879",
"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": "efd6b512-8253-414a-96d4-f0ccbbda9840",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e8833d99-27cd-4e11-8453-b30ee4700602",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "026f99e4-5cc8-40d1-b58b-b8e89053e523",
"account_manager_user_code": "sample string 56",
"company_status_id": "8dc56b30-dd69-41dd-83ff-e0c2ba3d0168",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-01-20T13:13:55.7103598+00:00",
"id2": 60
},
"db_language_id": "b8fa7152-7f75-45dd-a17d-a5d28d55ab5b",
"db_language_code": "sample string 7",
"db_title_id": "e687e823-2a53-496d-8c70-cc99158606d5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-01-20T13:13:55.7103598+00:00",
"create_date": "2025-01-20T13:13:55.7103598+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": "2025-01-20T13:13:55.7103598+00:00"
},
"modified_dateutc": "2025-01-20T13:13:55.7103598+00:00",
"id2": 22
}