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": "40dc399f-f777-4517-91fb-30ad2bfd8233",
"_parent_id": "061f6945-eb61-4b15-82a3-7b68bce75f28",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "52fb7107-23a1-4328-998c-0a61314f9d0f",
"company_id": "613df46c-783c-4610-91b1-4f1e3bf4a97a",
"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": "a04e4948-8e72-45c9-9bb1-a606594e1a48",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d572c927-6562-4b04-9ba9-17456f51e269",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "dda1b6e5-ee3d-41e8-b54a-f5136984bfdd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1771cc3a-9ac1-45fc-8230-70ff727356b5",
"company_code": "sample string 5",
"company": {
"id": "86ad3eee-118d-49d0-9b27-e5888ea2122b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-03T09:38:11.7189887+00:00",
"sales_territory_id": "821757df-0bac-45dd-874f-1df53929a6c0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b269c5f9-e540-4577-aa72-b1c88d9d829f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eab67e58-478f-4efd-b43e-732bc1b0762f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "49420a95-ab6c-4ed7-b74f-1833c0502d65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04c67004-74f1-477d-ab6f-53cdc2fc5f73",
"db_currency_id": "31f9fe37-84fa-4dd5-970b-004f35e818fe",
"db_language_id": "5f46b43c-fceb-407d-ab94-33e4dc699f02",
"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-04-03T09:38:11.7189887+00:00"
},
"modified_dateutc": "2025-04-03T09:38:11.7189887+00:00"
},
"marketing_segment_id": "29eab153-86c6-490e-8d1b-4a3e19bb871a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d6cf24f1-cc71-4df3-a0e1-6302431ad72d",
"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": "99b322a8-7f07-4d83-8287-b61c8d45e392",
"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": "54892a06-a5d0-467d-9491-9b8fa3db9be5",
"db_country_code": "sample string 28",
"feelist_id": "7ca87965-0e07-4023-9641-d1c67b5f64be",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fea628b7-5753-4109-8089-7a941d70997c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "de566099-785b-4449-a94f-3ff8a8bb465f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-03T09:38:11.7189887+00:00",
"db_currency_id": "e2c4d355-7fd5-4b29-b959-e5d9c2ef8134",
"db_currency_code": "sample string 10"
},
"company_type_id": "d19a4e9f-26d8-46d4-ba0e-faeef9ff8e9c",
"company_type_name": "sample string 32",
"company_type": {
"id": "051b3feb-423d-4b4a-bdf0-be8031243237",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "56b56f1f-c311-4d04-82d0-408746146ff1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f41036a6-2ffc-4dba-91b9-a4b03fabe5c5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "99373ba3-c65f-4bd9-af8f-ff620e037ccd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b88563df-bb4f-4b23-9c51-6108b61bf157",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c8d14aee-94df-4f9f-bfa5-ba46ee42b56a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-03T09:38:11.7189887+00:00"
},
"company_sector_id": "319e07cc-4f49-46aa-887a-553c9a0335b5",
"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": "c87975b7-c3a5-4a5a-a114-5f8abc08e6a6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5e55f6c7-692b-4715-a248-e6ed7880d12b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "858d8337-dd04-410d-911c-6bac9fbea6e9",
"account_manager_user_code": "sample string 56",
"company_status_id": "8a18848b-eae1-4607-a529-18969b57ebc4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-03T09:38:11.7189887+00:00",
"id2": 60
},
"db_language_id": "7dd27432-0334-4ce0-acff-62f7cf097c81",
"db_language_code": "sample string 7",
"db_title_id": "240f9a48-fe32-4b4b-b537-80af81002f01",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-03T09:38:11.7189887+00:00",
"create_date": "2025-04-03T09:38:11.7189887+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-04-03T09:38:11.73463+00:00"
},
"modified_dateutc": "2025-04-03T09:38:11.73463+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": "5b97e118-0e6b-45dd-b243-41110c35e3ae",
"_parent_id": "a341790c-4763-4f43-85c3-0c927cecdd64",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "66c9f5f1-4122-409c-b22a-f248a07f18e6",
"company_id": "cc0a0d25-1aef-40af-8471-e0b546ca044d",
"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": "dca9544e-4107-4887-b73f-1f92b9224f71",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "99fe7048-a46b-4fe5-b074-58d47a4df97c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "5f4c5a0a-2dde-44b0-8e8b-5e9fc3229cb8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "22c0056f-1cac-40fe-bfc0-19f8a4f2231d",
"company_code": "sample string 5",
"company": {
"id": "72af1dfc-4257-4151-9359-9ea1c4ac2f52",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-03T09:38:11.7971155+00:00",
"sales_territory_id": "aa83c890-0aec-4b83-9052-deec52bef91e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1e86915a-defb-4fad-addb-c4d2e3307fcb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a64052f8-7fe5-4219-b075-c9fd1d121008",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9f22f4ca-5168-4c7a-b98f-3d9b1580125a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c4719d84-d6a1-4733-9811-dda86e5b3327",
"db_currency_id": "3853dd76-cf25-4ffd-868e-a0d647a2574c",
"db_language_id": "c8985121-2782-4f36-aaeb-255286147b5e",
"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-04-03T09:38:11.7971155+00:00"
},
"modified_dateutc": "2025-04-03T09:38:11.7971155+00:00"
},
"marketing_segment_id": "007fcb27-3ffa-4074-859a-1e757276635f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9af3bcd9-24ba-43ed-a44d-ecbea67f375b",
"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": "db2ab4b4-c605-4e07-86dc-6c1ff649d18b",
"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": "bbf06fa6-1f53-46c3-88dd-ca067c202a0d",
"db_country_code": "sample string 28",
"feelist_id": "47430bc3-68e6-4810-98cc-73ca7ca880b6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3073c999-b625-4988-a134-2f528404d669",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7c33dd80-fcca-47b0-a90d-f6bbb0667502",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-03T09:38:11.7971155+00:00",
"db_currency_id": "f51c874b-7e1f-4e77-8d9b-358d433926b0",
"db_currency_code": "sample string 10"
},
"company_type_id": "3914119e-18de-4ea8-9c76-b6295e6a7624",
"company_type_name": "sample string 32",
"company_type": {
"id": "128f93a7-100c-491d-8a37-24e63e2b5c64",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fc0b03d0-16b1-46b8-a7aa-0666e83a4268",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ca365d14-ed88-44fc-9d4f-53a38d6ea411",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9f0cf8fc-40d0-44fc-be88-17fcf81789f1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "76383233-ce26-4680-9669-6190fb762305",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "43923d30-d9c1-46e9-b3ce-b891e57200ad",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-03T09:38:11.7971155+00:00"
},
"company_sector_id": "74919137-b53a-4d77-a0a7-703ee9751e1e",
"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": "1f64f6f7-3598-416c-a98f-5f609d477d2c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bf1b7a2a-ea35-4992-a108-76fa9746d38d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2d5ea5d1-181e-4580-a15b-113f34f5092f",
"account_manager_user_code": "sample string 56",
"company_status_id": "03678a0a-dc40-4cfe-879e-edb2bbbb8b60",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-03T09:38:11.7971155+00:00",
"id2": 60
},
"db_language_id": "95340a06-c052-4216-9cc8-ea808054204f",
"db_language_code": "sample string 7",
"db_title_id": "7f059df6-067f-4928-b239-74721e8020f2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-03T09:38:11.7971155+00:00",
"create_date": "2025-04-03T09:38:11.7971155+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-04-03T09:38:11.7971155+00:00"
},
"modified_dateutc": "2025-04-03T09:38:11.7971155+00:00",
"id2": 22
}