Creates a new company
Request Information
URI Parameters :
None.
Body Parameters :
company| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| is_client |
SALES : Indicate if can be used for ordering |
boolean | |
| is_supplier |
SERVICES : indicate if this company is a supplier |
boolean | |
| archived |
Archive this company to not have it anymore on the search |
boolean | |
| name | string |
Required Max length: 64 |
|
| notes |
Notes/Remark field |
string | |
| create_date |
Creation date+time |
date | |
| sales_territory_id |
Territory of the company (Sales+Services).If more than one sales_territory exists, then it must be filled |
globally unique identifier | |
| sales_territory_code |
Embedded entity "sales_territory" using ERP PK when adding/updating company |
string | |
| sales_territory |
Embedded entity "sales_territory" using node when adding/updating company |
sales_territory | |
| marketing_segment_id |
Marketing Segment of the company (Sales (Visit frequency logic) +Services (Planning Jobs To Be Planned) ) |
globally unique identifier | |
| marketing_segment_code |
Embedded entity "marketing_segment" using ERP PK when adding/updating company |
string | |
| marketing_segment |
Embedded entity "marketing_segment" using node when adding/updating company |
marketing_segment | |
| sales_organization_id |
Organization on which belongs the company.If more than one sales_organization exists, then it must be filled |
globally unique identifier | |
| sales_organization_code |
Embedded entity "sales_organization" using ERP PK when adding/updating company |
string | |
| sales_organization |
Embedded entity "sales_organization" using node when adding/updating company |
sales_organization | |
| company_sales_status_code |
Foreign key of company_sales_status using code. Use "Normal,CreditRisk, BlockedbyCM or OrderBlocked" |
string | |
| vat_reg_code |
VAT number |
string |
Max length: 50 |
| is_working_address |
Services : If False, you cannot create project/installation on this company.Default=true |
boolean | |
| parent_id |
Reference to a parent company (in case of Child/Parent) when adding/updating company |
globally unique identifier | |
| parent_company_code |
Embedded entity "company" for parent (in case of Child/Parent) using ERP PK when adding/updating company |
string | |
| parent_company |
Embedded entity "company" for parent (in case of Child/Parent) when adding/updating company |
company | |
| phone |
Phone number of the company |
string |
Max length: 50 |
| fax |
Fax number of the company |
string |
Max length: 50 |
| url |
URL of the company website |
string |
Max length: 255 |
|
|
string |
Max length: 250 |
|
| street |
Address:Street |
string |
Max length: 100 |
| street_number |
Address:Street Number. If your ERP doesn't have this field, then only use field "street" and disable the street number on Odyssee/Admin/Impl Settings/Global Settings:Hide Street Number |
string |
Max length: 50 |
| city |
Address:City |
string |
Max length: 50 |
| zip |
Address:Zip |
string |
Max length: 50 |
| db_country_id |
Address:Country |
globally unique identifier | |
| db_country_code |
Address:CountryCode entity using international code when adding/updating company |
string | |
| feelist_id |
FeeList activated for the company (On Service, Feelist determines the price of the invoicable timesheets) |
globally unique identifier | |
| feelist_reference_back_office |
Embedded entity "feelist" using ERP PK when adding/updating company |
string | |
| feelist |
Embedded entity "feelist" using node when adding/updating company |
feelist | |
| company_type_id |
Company Type |
globally unique identifier | |
| company_type_name |
Embedded entity "company_type" using ERP PK when adding/updating company |
string | |
| company_type |
Embedded entity "company_type" using node when adding/updating company |
company_type | |
| db_language_id |
Language of the company.If empty, will use the default on the system |
globally unique identifier | |
| db_language_code |
Language code entity using international isocode when adding/updating company |
string | |
| code |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
| article_price_label_id |
Foreign key of article price label |
globally unique identifier | |
| article_price_label_code |
Embedded entity "article price label" using ERP PK when adding/updating |
string | |
| article_price_label |
Embedded entity "article price label" when adding/updating |
article_price_label | |
| db_payment_method_id |
Embedded entity "db payment methods" using ERP PK when adding/updating company |
globally unique identifier | |
| db_payment_method_reference_back_office |
Embedded entity "db payment methods" using ERP PK when adding/updating company |
string | |
| db_payment_methods |
Embedded entity "db payment methods" using ERP PK when adding/updating company |
db_payment_methods | |
| company_sector_id |
Foreign key to company_sector |
globally unique identifier | |
| company_sector_code |
Embedded code for the company_sector using ERP PK when adding/updating |
string | |
| company_sector |
Embedded entity for the company_sector using the key from an external system when adding/updating object |
company_sector | |
| is_lead |
Indicate that company is not already a customer |
boolean | |
| is_subcontractor |
For Service, that company is one of your subcontractors |
boolean | |
| latitude |
Decimal coordonate for the latitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
| longitude |
Decimal coordonate for the longitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
| street2 |
Additional information on the address not part of the postal address |
string | |
| bic_code |
bic code |
string | |
| specialities |
specialities |
string | |
| register_number |
register_number |
string | |
| register_city |
register_city |
string | |
| bankaccount |
Bank account of the company. |
string | |
| mobile |
Mobile number of the company |
string |
Max length: 50 |
| service_manager_user_id |
ID of the service manager. Auto selected user when creating location, installation. Used also inside communication and tags |
globally unique identifier | |
| service_manager_user_code |
Embedded code of the service manager. Auto selected user when creating location, installation. Used also inside communication and tags |
string | |
| service_manager_user |
Embedded entity of the service manager. Auto selected user when creating location, installation. Used also inside communication and tags |
user | |
| finance_manager_user_id |
ID of the finance manager. Only used inside communication and tags |
globally unique identifier | |
| finance_manager_user_code |
Embedded code of the finance manager. Only used inside communication and tags |
string | |
| finance_manager_user |
Embedded entity of the finance manager. Only used inside communication and tags |
user | |
| account_manager_user_id |
ID of the account manager. Only used inside communication and tags |
globally unique identifier | |
| account_manager_user_code |
Embedded code of the account manager. Only used inside communication and tags |
string | |
| account_manager_user |
Embedded entity of the account manager. Only used inside communication and tags |
user | |
| company_status_id |
Company Status |
globally unique identifier | |
| invoice_email_to |
Email to send invoice |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| id2 |
Internal ID (numeric) |
integer |
Request Formats :
application/json, text/json
{
"id": "61658f49-65b5-4438-bf78-58019a21e9d9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-12-21T13:35:14.6313322+00:00",
"sales_territory_id": "6fb00a15-2215-470e-95a6-723aec40a219",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f78b12a8-6a82-4c9e-bf10-82f8c9cb54b9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c178e633-9960-4e5b-9b3f-cc07ba581c7c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "79734aaf-5b17-4904-b73c-3dedbfa7e154",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0a6a0bc-eb33-4f87-bffa-8435a0e0adbb",
"db_currency_id": "665fb14b-0d04-4698-8788-ac2ce4fc8697",
"db_language_id": "59b8f0a8-3c94-479e-ba18-837f15a43e6b",
"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-12-21T13:35:14.6313322+00:00"
},
"modified_dateutc": "2024-12-21T13:35:14.6313322+00:00"
},
"marketing_segment_id": "3b3d643a-6aa9-491b-9cea-9be7f9c2bca8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8e80b6ee-26f3-4c1b-9ce1-577cf2dfa61e",
"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": "c25dd381-65c7-4fb7-9264-230e08ead55d",
"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": "2e67eb55-9add-46d5-9a4b-180647d33ba1",
"db_country_code": "sample string 28",
"feelist_id": "b0d0df1e-ff8c-46fd-b044-2ab386871122",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3e8173d8-8c21-44e0-9a4e-e6eeb9ca8675",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0fbc57fd-8ce9-4dc2-9d29-629d1e9fdd00",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-12-21T13:35:14.6313322+00:00",
"db_currency_id": "3355d124-9877-4d44-ad7d-386843cfb4c2",
"db_currency_code": "sample string 10"
},
"company_type_id": "038f2117-de27-448b-9c37-3f2aef187ba6",
"company_type_name": "sample string 32",
"company_type": {
"id": "ebca7ec3-a09b-4e02-9db6-e043ef763ed6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e171d374-1411-4b44-b943-2565067703f8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6fc1ba39-13bc-4fbb-b791-015f45279b76",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "764eff75-941d-40fe-a536-eacc16aebb9d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a474a38c-54c6-4917-9cb3-44d03c109415",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3f7f00d4-f303-4e4b-9b24-15c94638efd5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-12-21T13:35:14.6313322+00:00"
},
"company_sector_id": "e59420ce-ccec-4b39-a385-7f1eeec7d817",
"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": "c7a7e472-a122-4f23-b829-dcc60de799c4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2a1571cd-f868-4a86-907c-8882080a8b98",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "aea661cc-08f5-4113-b2ad-129e40f8096f",
"account_manager_user_code": "sample string 56",
"company_status_id": "42f2b801-8faa-445d-b394-724c3674465b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-12-21T13:35:14.6313322+00:00",
"id2": 60
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.