Skip to main content

Interface: CompanySearchArguments

Defined in: type/CompanySearchArguments.ts:7

Input object for CompanySearchArguments

Properties​

companyIds?​

optional companyIds?: number[]

Defined in: type/CompanySearchArguments.ts:9

List of unique company ids

createdAt?​

optional createdAt?: DateSearchInput

Defined in: type/CompanySearchArguments.ts:23

Search by date created

lastModifiedAt?​

optional lastModifiedAt?: DateSearchInput

Defined in: type/CompanySearchArguments.ts:21

Search by date changed

managedCompaniesOnly?​

optional managedCompaniesOnly?: boolean

Defined in: type/CompanySearchArguments.ts:13

When true, only companies managed by the viewer will be listed

name?​

optional name?: string

Defined in: type/CompanySearchArguments.ts:11

Company's name

offset​

offset: number

Defined in: type/CompanySearchArguments.ts:17

offset input field

page​

page: number

Defined in: type/CompanySearchArguments.ts:15

page input field

sort?​

optional sort?: CompanySortInput[]

Defined in: type/CompanySearchArguments.ts:19

List of company sort filters

term?​

optional term?: string

Defined in: type/CompanySearchArguments.ts:26

Free-text search term. Text fields are matched as a case-insensitive substring; the numeric *_ID fields are matched by exact id (and apply only when the term is numeric). By default it searches the company's own fields (name, taxNumber, cocNumber, notes, debtorId, email); restrict or extend the searched fields with termFields. Multi-word terms must all match (AND). Each word must be at least 3 characters, except numeric id values which may be shorter.

termFields?​

optional termFields?: CompanyTermField[]

Defined in: type/CompanySearchArguments.ts:28

Fields the term searches. Text fields match by case-insensitive substring; the *_ID fields (COMPANY_ID, COMPANY_ADDRESS_ID, CONTACT_ID) match by exact id and apply only when the term is numeric. When omitted, only company fields are searched. Include address or contact fields to also search the company's addresses or contacts.