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": "4b5e208d-81ea-4958-9ed7-a1a8416dbf92",
"_parent_id": "0d8f3bd7-37fc-4a1b-afb1-65578d5b33db",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "536502d6-aaa7-47c3-aff6-9e3171e2a65e",
"company_id": "d4f0ffcb-0732-4970-9382-4495774b6387",
"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": "21f6999e-7938-4c65-a413-8255192bfc12",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "70c67731-dbd1-46c1-91df-7cf824cdc7de",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0a29575e-5c2a-4e28-8bc6-282f97e2a5fb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3c4f763a-22aa-4b3f-b9ef-017a25b1e1ec",
"company_code": "sample string 5",
"company": {
"id": "9a5ea6b5-c137-44f9-bfa7-bb1bfb956f16",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-21T05:35:22.1145419+00:00",
"sales_territory_id": "1a62c3a8-8299-42a6-b805-fa63593fba65",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9fa7e14a-1563-447c-911e-4a006764fed4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e5c10682-1f8e-4452-9ee0-66774d0b71fd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "36474dad-6cd2-427c-9b30-988cd881c787",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f86b9e4-484f-4b40-86bf-ed4d0e8fe744",
"db_currency_id": "f73f1f2b-4716-4128-8fd5-4ae4efcf5074",
"db_language_id": "eb45befd-f678-4d55-b001-d3655022bf5e",
"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": "2026-10-21T05:35:22.1145419+00:00"
},
"modified_dateutc": "2026-10-21T05:35:22.1145419+00:00"
},
"marketing_segment_id": "7701fd30-f583-49c9-8196-40f78f528060",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0082e779-0a5a-4ca9-9eb6-c0f5df1da37e",
"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": "a8d984a0-c131-4e5c-a4d9-5fcbef5236c4",
"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": "5a37b914-247e-4725-af1c-11293dfca9c3",
"db_country_code": "sample string 28",
"feelist_id": "2d10989c-f610-456c-a2f0-f16dc117a51c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d66b4b82-b86d-4639-b85d-bde7d6f8d0e3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "df376ddf-cb8b-4ec7-866d-86f9aa16c597",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-21T05:35:22.1145419+00:00",
"db_currency_id": "cca18131-fc13-4679-afd9-54990a48731c",
"db_currency_code": "sample string 10"
},
"company_type_id": "83da2b39-dc8f-4b07-bf5f-834ed0156727",
"company_type_name": "sample string 32",
"company_type": {
"id": "768b5422-db82-486c-a3ea-2dbb6f0a5938",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "af764c95-7294-4444-864d-1b9639a91b87",
"sales_organization_code": "sample string 5"
},
"db_language_id": "477d2ce1-7551-49f8-92e0-5d6b1733cc69",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "59dc77c2-f1c5-41fc-ad88-57357a647b0d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "27dd73f2-b812-415f-972d-a577ed28d488",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b53423da-fa55-479b-b36d-895b6a0f3779",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-21T05:35:22.1145419+00:00"
},
"company_sector_id": "573fa96e-beeb-471b-b28e-0150dc97cd32",
"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": "02df5588-5e22-4104-95c7-a2ea85fda440",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d1a36170-1d25-4a74-8f5a-53629d81f0ba",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "22ff3715-90c6-4dda-a112-f904bdb16148",
"account_manager_user_code": "sample string 56",
"company_status_id": "df64a133-ba98-4e38-9fb9-f9abba7ce38d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-21T05:35:22.1145419+00:00",
"id2": 60
},
"db_language_id": "e41cb799-052f-46f7-9a3d-a814f7ec224b",
"db_language_code": "sample string 7",
"db_title_id": "7c400596-189c-4ca1-83c7-5ec7d340bf77",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-21T05:35:22.1145419+00:00",
"create_date": "2026-10-21T05:35:22.1145419+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": "2026-10-21T05:35:22.1145419+00:00"
},
"modified_dateutc": "2026-10-21T05:35:22.1145419+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": "fe41f0fe-f202-4f16-9d4c-0dc8f82f7556",
"_parent_id": "03d88294-07f3-400c-b7fa-9816a673250c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e49129a7-9db0-4cd2-b019-af53bb0d84de",
"company_id": "96c668a0-5b96-4814-98bc-103cf33403ec",
"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": "2cc644a8-4e4f-44e5-a9b6-e534465e0e22",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a02d47bf-ac2d-4bc6-932a-b7b45424a618",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "7c28212f-a257-468a-a39f-07e7d8a8da96",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "26057128-f67a-434e-a6c9-4fc7c804f9e3",
"company_code": "sample string 5",
"company": {
"id": "a9470b97-19f1-4812-8a7b-607fe84d8eeb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-21T05:35:22.1457923+00:00",
"sales_territory_id": "a9d85d61-0500-460c-86f7-b5963af25fe2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b102f982-4e5f-4651-aaf9-bb7fbd79fb1c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "24bfc3ba-e72b-42bb-b5f0-fe086e482571",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0b23f4d1-f95b-470e-864d-bfc974722c88",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34688acb-be21-4825-8e96-a5540d0aa9e6",
"db_currency_id": "ea1de928-a860-4a29-90ea-392343a891c4",
"db_language_id": "0dfd7364-97fe-415e-a619-980e978aead1",
"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": "2026-10-21T05:35:22.1457923+00:00"
},
"modified_dateutc": "2026-10-21T05:35:22.1457923+00:00"
},
"marketing_segment_id": "352f7c15-75aa-47fd-99d7-6d0f9163a8ac",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "69fed420-a558-4033-9b29-1565d0fced1c",
"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": "0ef99713-257e-416c-88c8-46d2114ae0ac",
"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": "41ee2189-ad32-4a0b-ad4f-fe268ea0a093",
"db_country_code": "sample string 28",
"feelist_id": "5a29901e-e177-4c3e-85e1-38ba09a5538f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "02468f07-7ca3-4633-adc3-a9a5a1d8d1d6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5d35b3d3-31fa-4ebb-bafa-fb5b11a668e0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-21T05:35:22.1457923+00:00",
"db_currency_id": "04dd37fa-a997-4a73-a1b9-fe8b0da9d6c4",
"db_currency_code": "sample string 10"
},
"company_type_id": "8e530709-3a3f-4d27-97df-d488baeea0a0",
"company_type_name": "sample string 32",
"company_type": {
"id": "93b3883e-f64a-4f1b-8d17-730ed129812a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d718b188-d89d-48a8-84b5-13fb8ee9e458",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9e4c9c26-5e30-4085-a1cd-df7fefd92af0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2490c183-8d2b-4462-b327-532187af6392",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "295b1f71-22de-41a0-948f-87fa811ea404",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "04362745-2157-40b0-b52a-f59412031bab",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-21T05:35:22.1457923+00:00"
},
"company_sector_id": "a06d6e6a-5ee1-44cf-80e2-c33d18a68e29",
"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": "b48f84ce-2043-4f4c-bc51-c5b3bba0c098",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "58684f13-758f-4423-add0-50203c0d6cc5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "18bbaeda-0ba5-4266-a6eb-8882167bc6bd",
"account_manager_user_code": "sample string 56",
"company_status_id": "ebfe7e6e-1301-4b05-96c8-3bf2103da01c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-21T05:35:22.1457923+00:00",
"id2": 60
},
"db_language_id": "e9c17628-8e1b-4016-bc3b-a2ca7e8a629b",
"db_language_code": "sample string 7",
"db_title_id": "12f6a5b7-5f8e-40e8-8d90-68d7bc13eb20",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-21T05:35:22.1457923+00:00",
"create_date": "2026-10-21T05:35:22.1457923+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": "2026-10-21T05:35:22.1457923+00:00"
},
"modified_dateutc": "2026-10-21T05:35:22.1457923+00:00",
"id2": 22
}