Updates the company with the specified key
Request Information
URI Parameters :
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
Body Parameters :
companyName | 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": "839d78a2-b5eb-4a3f-a3e7-524bf2d34807", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2024-07-20T07:21:31.5929141+00:00", "sales_territory_id": "ce1eb0cf-36f7-4c78-8bc1-edbee11be877", "sales_territory_code": "sample string 9", "sales_territory": { "id": "40b1b1a5-fd0b-4e1e-afaa-ff4d8eb53968", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "5a3b74a9-2fcf-4152-904c-3cc23e176137", "sales_organization_code": "sample string 5", "sales_organization": { "id": "838a3c27-cb56-4286-aea4-58bfe3b39959", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d46b5ba8-e9ac-4c28-88ee-4691df259d92", "db_currency_id": "53a8e182-ac0d-4c0b-9e5e-8e09181cb2f6", "db_language_id": "b9421d4a-2df3-4fea-b232-db32b25ea84b", "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-07-20T07:21:31.5929141+00:00" }, "modified_dateutc": "2024-07-20T07:21:31.5929141+00:00" }, "marketing_segment_id": "c312efd9-9fc3-48a6-8bce-244e0ff68910", "marketing_segment_code": "sample string 11", "sales_organization_id": "96c96f79-ae3b-4c41-a8a0-911b148d0774", "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": "0f64e12b-4006-41ba-850c-7ae45ff30207", "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": "f806b00e-97ed-4297-81c9-90a675510e97", "db_country_code": "sample string 28", "feelist_id": "e1ef42e6-addb-4634-87ee-88a4461be5f1", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "21ae3eb6-db28-4ac4-b770-93ccf4f252fc", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "76cd9e18-06be-45cb-834d-7800e6c5a9c6", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2024-07-20T07:21:31.5929141+00:00", "db_currency_id": "37fbb470-f71c-41ae-8894-01a2474db649", "db_currency_code": "sample string 10" }, "company_type_id": "9c9ec544-5f55-42ce-8c97-f7035a5f3720", "company_type_name": "sample string 32", "company_type": { "id": "ba7f9e01-7ef9-4c5e-80f8-4953a3b34996", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "bd37087b-c38e-4709-86cf-9281692455da", "sales_organization_code": "sample string 5" }, "db_language_id": "61153b35-d5e0-4afd-afa4-9777ca106b0d", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "0b7fb4ba-c250-4413-bda8-552492067512", "article_price_label_code": "sample string 37", "db_payment_method_id": "e1f05894-06f5-47fd-86dd-79d6cb97d21d", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "4112952c-b0b1-42db-8885-41797bf84e7f", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2024-07-20T07:21:31.5929141+00:00" }, "company_sector_id": "4f9372ae-418e-4f08-b9cf-7946ab22140a", "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": "a8d9a576-7729-4100-9483-6fff11b319c2", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "a5da3dbc-2c2d-43dc-a9d7-7d4f33d8edb4", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "8febee88-457c-4692-91c4-f79d3e846229", "account_manager_user_code": "sample string 56", "company_status_id": "cfae3c85-39a9-47bc-bd1b-f407c8130900", "invoice_email_to": "sample string 58", "modified_dateutc": "2024-07-20T07:21:31.5929141+00:00", "id2": 60 }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.