Retrieves all the companies

Request Information

URI Parameters :

None.

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

company
NameDescriptionTypeAdditional 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

email

email

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 Wello/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
po_number_required

Is the number required or not?

boolean
invoice_contact_id

The contact id of invoice

globally unique identifier
due_monthend

Due monthend of invoice

boolean
payement_conditions

Payement conditions of invoice

string
udf1

Custom field udf1

string
udf2

Custom field udf2

string
udf3

Custom field udf3

string
udf4

Custom field udf4

string
udf5

Custom field udf5

string
udf6

Custom field udf6

string
udf7

Custom field udf7

string
udf8

Custom field udf8

string
udf9

Custom field udf9

string
udf10

Custom field udf10

string
udf11

Custom field udf11

string
udf12

Custom field udf12

string
udf13

Custom field udf13

string
udf14

Custom field udf14

string
udf15

Custom field udf15

string
udf16

Custom field udf16

string
udf17

Custom field udf17

string
udf18

Custom field udf18

string
udf19

Custom field udf19

string
udf20

Custom field udf20

string
udf21

Custom field udf21

string
udf22

Custom field udf22

string
udf23

Custom field udf23

string
udf24

Custom field udf24

string
udf25

Custom field udf25

string
udf26

Custom field udf26

string
udf27

Custom field udf27

string
udf28

Custom field udf28

string
udf29

Custom field udf29

string
udf30

Custom field udf30

string
udf31

Custom field udf31

string
udf32

Custom field udf32

string
udf33

Custom field udf33

string
udf34

Custom field udf34

string
udf35

Custom field udf35

string
udf36

Custom field udf36

string
udf37

Custom field udf37

string
udf38

Custom field udf38

string
udf39

Custom field udf39

string
udf40

Custom field udf40

string
udf41

Custom field udf41

string
udf42

Custom field udf42

string
udf43

Custom field udf43

string
udf44

Custom field udf44

string
udf45

Custom field udf45

string
udf46

Custom field udf46

string
udf47

Custom field udf47

string
udf48

Custom field udf48

string
udf49

Custom field udf49

string
udf50

Custom field udf50

string
udf51

Custom field udf51

string
udf52

Custom field udf52

string
udf53

Custom field udf53

string
udf54

Custom field udf54

string
udf55

Custom field udf55

string
udf56

Custom field udf56

string
udf57

Custom field udf57

string
udf58

Custom field udf58

string
udf59

Custom field udf59

string
udf60

Custom field udf60

string
udf61

Custom field udf61

string
udf62

Custom field udf62

string
udf63

Custom field udf63

string
udf64

Custom field udf64

string
udf65

Custom field udf65

string
udf66

Custom field udf66

string
udf67

Custom field udf67

string
udf68

Custom field udf68

string
udf69

Custom field udf69

string
udf70

Custom field udf70

string
udf71

Custom field udf71

string
udf72

Custom field udf72

string
udf73

Custom field udf73

string
udf74

Custom field udf74

string
udf75

Custom field udf75

string
udf76

Custom field udf76

string
udf77

Custom field udf77

string
udf78

Custom field udf78

string
udf79

Custom field udf79

string
udf80

Custom field udf80

string
udf81

Custom field udf81

string
udf82

Custom field udf82

string
udf83

Custom field udf83

string
udf84

Custom field udf84

string
udf85

Custom field udf85

string
udf86

Custom field udf86

string
udf87

Custom field udf87

string
udf88

Custom field udf88

string
udf89

Custom field udf89

string
udf90

Custom field udf90

string
udf91

Custom field udf91

string
udf92

Custom field udf92

string
udf93

Custom field udf93

string
udf94

Custom field udf94

string
udf95

Custom field udf95

string
udf96

Custom field udf96

string
udf97

Custom field udf97

string
udf98

Custom field udf98

string
udf99

Custom field udf99

string
udf100

Custom field udf100

string

Response Formats

application/json, text/json

Sample:
{
  "id": "fa044f21-d0d9-4376-82e8-78c61367cf93",
  "is_client": true,
  "is_supplier": true,
  "archived": true,
  "name": "sample string 5",
  "notes": "sample string 6",
  "create_date": "2024-09-29T01:33:48.7931075+00:00",
  "sales_territory_id": "2f3c9d61-e1ea-4ac3-8ec8-93d3fb50ae5b",
  "sales_territory_code": "sample string 9",
  "sales_territory": {
    "id": "3d7d7bc6-6fb3-4dee-afb9-62b54f9aab45",
    "code": "sample string 2",
    "description": "sample string 3",
    "sales_organization_id": "9129f07d-7509-4c16-b739-42ecce7bd6da",
    "sales_organization_code": "sample string 5",
    "sales_organization": {
      "id": "ad2eeb24-df2f-47f5-9e8c-1619beda66db",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "2a5c204f-c24e-4677-b6c9-f781ed10e4a0",
      "db_currency_id": "58b8c58d-c960-4d21-ab09-b40179d4b4e1",
      "db_language_id": "11a96893-72db-4996-83c3-3f1b9cc5b910",
      "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-09-29T01:33:48.8130074+00:00"
    },
    "modified_dateutc": "2024-09-29T01:33:48.8130074+00:00"
  },
  "marketing_segment_id": "9ad97a48-5abf-40d6-ab1e-c36055e4f595",
  "marketing_segment_code": "sample string 11",
  "sales_organization_id": "29f27c25-2877-4044-8b96-2431dfeee2a7",
  "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": "30dd16d7-1892-4e40-b000-6f17b79df967",
  "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": "5565b4d3-2c43-47b6-b7f2-7c874095e8a3",
  "db_country_code": "sample string 28",
  "feelist_id": "2f11f2f3-cc2e-4f6e-9e76-3f40e9519437",
  "feelist_reference_back_office": "sample string 30",
  "feelist": {
    "id": "117774f6-5c10-4d65-b43c-c65bd91fbbb5",
    "name": "sample string 2",
    "description": "sample string 3",
    "is_default": true,
    "default_price": 1.0,
    "sales_organization_id": "2331f297-15df-4f3f-a17d-aa0ac10c974f",
    "sales_organization_code": "sample string 6",
    "reference_back_office": "sample string 7",
    "modified_dateutc": "2024-09-29T01:33:48.8130074+00:00",
    "db_currency_id": "aabf3a16-5d90-45e0-b231-381e47e81b73",
    "db_currency_code": "sample string 10"
  },
  "company_type_id": "a7d96d97-bc9d-4c5a-874e-3e5d9aebdf12",
  "company_type_name": "sample string 32",
  "company_type": {
    "id": "4ada22f0-30cf-4b05-88b9-5fd8e7b22554",
    "name": "sample string 2",
    "description": "sample string 3",
    "sales_organization_id": "4c69b8b6-9b0f-4411-b1bd-071d7925fce8",
    "sales_organization_code": "sample string 5"
  },
  "db_language_id": "d82c4880-128a-4ba6-ae33-63129f01f3fc",
  "db_language_code": "sample string 34",
  "code": "sample string 35",
  "article_price_label_id": "deeaaa60-ba45-4ded-ab7b-73b47425a28d",
  "article_price_label_code": "sample string 37",
  "db_payment_method_id": "5bdfdc43-b92f-409f-84c5-c09606ba2e71",
  "db_payment_method_reference_back_office": "sample string 39",
  "db_payment_methods": {
    "id": "994f363b-8c8b-4950-9d9b-7d6cc77f1be6",
    "name": "sample string 2",
    "pm": "sample string 3",
    "description": "sample string 4",
    "reference_back_office": "sample string 5",
    "activated": true,
    "modified_dateutc": "2024-09-29T01:33:48.8130074+00:00"
  },
  "company_sector_id": "16f7357f-7ccf-401c-82b1-9c9959e9ac51",
  "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": "564dbf54-7f10-4f0a-a24f-612d898a574d",
  "service_manager_user_code": "sample string 52",
  "finance_manager_user_id": "ac253065-6d56-4f24-9a4e-36268bac28ed",
  "finance_manager_user_code": "sample string 54",
  "account_manager_user_id": "1781d08f-2a8d-4eb3-b2a6-0046139e2f34",
  "account_manager_user_code": "sample string 56",
  "company_status_id": "475c6e74-90ce-49c7-a5e6-bfa5b0afa121",
  "invoice_email_to": "sample string 58",
  "modified_dateutc": "2024-09-29T01:33:48.8130074+00:00",
  "id2": 60,
  "po_number_required": true,
  "invoice_contact_id": "1694344f-1e55-485b-8101-211488d32694",
  "due_monthend": true,
  "payement_conditions": "sample string 64",
  "udf1": "sample string 65",
  "udf2": "sample string 66",
  "udf3": "sample string 67",
  "udf4": "sample string 68",
  "udf5": "sample string 69",
  "udf6": "sample string 70",
  "udf7": "sample string 71",
  "udf8": "sample string 72",
  "udf9": "sample string 73",
  "udf10": "sample string 74",
  "udf11": "sample string 75",
  "udf12": "sample string 76",
  "udf13": "sample string 77",
  "udf14": "sample string 78",
  "udf15": "sample string 79",
  "udf16": "sample string 80",
  "udf17": "sample string 81",
  "udf18": "sample string 82",
  "udf19": "sample string 83",
  "udf20": "sample string 84",
  "udf21": "sample string 85",
  "udf22": "sample string 86",
  "udf23": "sample string 87",
  "udf24": "sample string 88",
  "udf25": "sample string 89",
  "udf26": "sample string 90",
  "udf27": "sample string 91",
  "udf28": "sample string 92",
  "udf29": "sample string 93",
  "udf30": "sample string 94",
  "udf31": "sample string 95",
  "udf32": "sample string 96",
  "udf33": "sample string 97",
  "udf34": "sample string 98",
  "udf35": "sample string 99",
  "udf36": "sample string 100",
  "udf37": "sample string 101",
  "udf38": "sample string 102",
  "udf39": "sample string 103",
  "udf40": "sample string 104",
  "udf41": "sample string 105",
  "udf42": "sample string 106",
  "udf43": "sample string 107",
  "udf44": "sample string 108",
  "udf45": "sample string 109",
  "udf46": "sample string 110",
  "udf47": "sample string 111",
  "udf48": "sample string 112",
  "udf49": "sample string 113",
  "udf50": "sample string 114",
  "udf51": "sample string 115",
  "udf52": "sample string 116",
  "udf53": "sample string 117",
  "udf54": "sample string 118",
  "udf55": "sample string 119",
  "udf56": "sample string 120",
  "udf57": "sample string 121",
  "udf58": "sample string 122",
  "udf59": "sample string 123",
  "udf60": "sample string 124",
  "udf61": "sample string 125",
  "udf62": "sample string 126",
  "udf63": "sample string 127",
  "udf64": "sample string 128",
  "udf65": "sample string 129",
  "udf66": "sample string 130",
  "udf67": "sample string 131",
  "udf68": "sample string 132",
  "udf69": "sample string 133",
  "udf70": "sample string 134",
  "udf71": "sample string 135",
  "udf72": "sample string 136",
  "udf73": "sample string 137",
  "udf74": "sample string 138",
  "udf75": "sample string 139",
  "udf76": "sample string 140",
  "udf77": "sample string 141",
  "udf78": "sample string 142",
  "udf79": "sample string 143",
  "udf80": "sample string 144",
  "udf81": "sample string 145",
  "udf82": "sample string 146",
  "udf83": "sample string 147",
  "udf84": "sample string 148",
  "udf85": "sample string 149",
  "udf86": "sample string 150",
  "udf87": "sample string 151",
  "udf88": "sample string 152",
  "udf89": "sample string 153",
  "udf90": "sample string 154",
  "udf91": "sample string 155",
  "udf92": "sample string 156",
  "udf93": "sample string 157",
  "udf94": "sample string 158",
  "udf95": "sample string 159",
  "udf96": "sample string 160",
  "udf97": "sample string 161",
  "udf98": "sample string 162",
  "udf99": "sample string 163",
  "udf100": "sample string 164"
}