Retrieves all the companies
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
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 |
Response Formats
application/json, text/json
{ "id": "b587ef1b-a3ab-4917-ad09-b631308cc259", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2024-03-28T21:56:40.4816565+00:00", "sales_territory_id": "525cc294-c1e3-4e93-936a-e69ddc20efc9", "sales_territory_code": "sample string 9", "sales_territory": { "id": "a85d4d07-5d17-4ac9-bd46-5a4433f2ff8c", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "64a22d73-c59c-435f-a52c-aea2cfe37572", "sales_organization_code": "sample string 5", "sales_organization": { "id": "9081f0e7-61cb-4d36-bd57-955bb9ee0b17", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6bf27e0f-217c-47d8-a99e-3dd8bd6e69e5", "db_currency_id": "598d2af1-fd8e-414d-a314-42105c2a6b79", "db_language_id": "d2e21ad9-154e-43e2-9ac3-c6fa64e90a8c", "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-03-28T21:56:40.4816565+00:00" }, "modified_dateutc": "2024-03-28T21:56:40.4816565+00:00" }, "marketing_segment_id": "2bad8306-98ff-453c-a2fa-8f62d97a8589", "marketing_segment_code": "sample string 11", "sales_organization_id": "44ad9cc4-4da6-4488-a29f-773864eb8415", "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": "ef933f36-ed08-4d38-9ba5-8268e5eeed74", "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": "f0627be1-95c7-4a34-8e3f-4d6c2bb78d16", "db_country_code": "sample string 28", "feelist_id": "4f1c2016-cad6-44ec-af10-35a276061e1a", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "c42a507b-e490-4435-b985-5a4b7c157e9c", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "651b635f-da43-4e7b-927b-1cc28d84cef6", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2024-03-28T21:56:40.4816565+00:00", "db_currency_id": "934dd05f-870c-4da5-a2fa-a4d97d5bb5b5", "db_currency_code": "sample string 10" }, "company_type_id": "d8f9dbe6-1bf9-4c93-a90d-b794ab2efec8", "company_type_name": "sample string 32", "company_type": { "id": "efa959e2-2794-4519-95d2-1e1d408c789b", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "bb60b3cb-3753-4c02-910c-4e27d6d38001", "sales_organization_code": "sample string 5" }, "db_language_id": "bec6e43c-3007-43bf-af3e-ab540d575e30", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "ee38cbaf-9359-4618-b30f-cb7ffeaa87dd", "article_price_label_code": "sample string 37", "db_payment_method_id": "72f49643-16c8-41a8-b45b-6b808afaf176", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "7c71de57-175b-41e0-bb88-118998e9916c", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2024-03-28T21:56:40.4816565+00:00" }, "company_sector_id": "d8894220-9bc8-4fe5-b5e1-79ad32c522b7", "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": "a9807f3d-7c4b-4e68-925d-44e904e6b773", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "c78a2e84-e333-4c95-b748-77853f0470d3", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "ca7a0428-a759-4a35-bdc4-de399047e255", "account_manager_user_code": "sample string 56", "company_status_id": "4cb69691-2459-4eaa-9436-1dfbc299c360", "invoice_email_to": "sample string 58", "modified_dateutc": "2024-03-28T21:56:40.4816565+00:00", "id2": 60 }