Guides
System Status
Start typing to search…

Filterable fields

In this section, we list the fields that you can filter with in your list requests.

👍

Options for filtering with createdTime and updatedTime

For filtering with createdTime and updatedTime, you can set a range of ISO 8601 date-time values.

  • yyyy-MM-dd'T'HH:mm:ss.SSSX
  • yyyy-MM-dd'T'HH:mm:ss.SSS
  • yyyy-MM-dd'T'HH:mm:ss
  • yyyy-MM-dd'T'HH:mm
  • yyyy-MM-dd

Vendors and Customers

Fields you can filter with

Available operators

id

eq (Equal)
ne (Not equal)
in (In)

archived

eq (Equal)
ne (Not equal)

name

eq (Equal)
sw (Starts with)

accountType

eq (Equal)
ne (Not equal)
in (In)
nin (Not in)

billCurrency (Vendors)
invoiceCurrency (Customers)

eq (Equal)
ne (Not equal)
in (In)
nin (Not in)

paymentStatus

eq (Equal)
ne (Not equal)
in (In)
nin (Not in)

createdTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

updatedTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

Bills and Invoices

Fields you can filter with

Available operators

id

eq (Equal)
ne (Not equal)
in (In)

archived

eq (Equal)
ne (Not equal)

vendorId (Bills)
customerId (Invoices)

eq (Equal)
in (In)

dueDate (Bills)

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

paymentStatus (Bills)

eq (Equal)
ne (Not equal)
in (In)

createdTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

updatedTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

payFromChartOfAccountId (Bills)

eq (Equal)
ne (Not equal)
in (In)

payToChartOfAccountId (Invoices)

eq (Equal)
ne (Not equal)
in (In)

classifications.chartOfAccountId (Bills)

eq (Equal)
ne (Not equal)
in (In)

classifications.accountingClassId

eq (Equal)
ne (Not equal)
in (In)

classifications.departmentId

eq (Equal)
ne (Not equal)
in (In)

classifications.locationId

eq (Equal)
ne (Not equal)
in (In)

classifications.itemId

eq (Equal)
ne (Not equal)
in (In)

Recurring bills

Fields you can filter with

Available operators

id

eq (Equal)
ne (Not equal)
in (In)

archived

eq (Equal)
ne (Not equal)

vendorId

eq (Equal)
in (In)

Credit memos

Fields you can filter with

Available operators

id

eq (Equal)
ne (Not equal)
in (In)

archived

eq (Equal)
ne (Not equal)

customerId

eq (Equal)
in (In)

referenceNumber

eq (Equal)

creditDate

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

payToChartOfAccountId

eq (Equal)
ne (Not equal)
in (In)

payToBankAccountId

eq (Equal)
ne (Not equal)
in (In)

status

eq (Equal)
ne (Not equal)
in (In)
nin (Not in)

createdTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

updatedTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

Bank accounts

Fields you can filter with

Available operators

id

eq (Equal)
ne (Not equal)
in (In)

archived

eq (Equal)
ne (Not equal)

status

eq (Equal)
ne (Not equal)
in (In)
nin (Not in)

type

eq (Equal)
ne (Not equal)

ownerType

eq (Equal)
ne (Not equal)

accessToAdmins

eq (Equal)
ne (Not equal)

createdTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

updatedTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

Payments

Fields you can filter with

Available operators

id

eq (Equal)
ne (Not equal)
in (In)

vendorId

eq (Equal)
ne (Not equal)
in (In)

processDate

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

amount

eq (Equal)
gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

transactionNumber

eq (Equal)

status

eq (Equal)
ne (Not equal)
in (In)
nin (Not in)

onlinePayment

eq (Equal)
ne (Not equal)

disbursementType

eq (Equal)
ne (Not equal)
in (In)

createdTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

updatedTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

Received payments

Fields you can filter with

Available operators

id

eq (Equal)
ne (Not equal)
in (In)

customerId

eq (Equal)
in (In)

paymentDate

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

receivablesType

eq (Equal)
ne (Not equal)
in (In)
nin (Not in)

status

eq (Equal)
ne (Not equal)
in (In)
nin (Not in)

onlinePayment

eq (Equal)
ne (Not equal)

createdTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

updatedTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

User roles

Fields you can filter with

Available operators

id

eq (Equal)
ne (Not equal)
in (In)

type

eq (Equal)
ne (Not equal)

createdTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

updatedTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

Organization users

Fields you can filter with

Available operators

id

eq (Equal)
ne (Not equal)
in (In)

archived

eq (Equal)
ne (Not equal)

role.type

eq (Equal)
ne (Not equal)
in (In)

createdTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

updatedTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

Classifications

Fields you can filter with

Available operators

id

eq (Equal)
ne (Not equal)
in (In)

archived

eq (Equal)
ne (Not equal)

name

eq (Equal)
sw (Starts with)

parentId

eq (Equal)
ne (Not equal)
in (In)

account.type (Chart of accounts)

eq (Equal)
ne (Not equal)

chartOfAccountId (Items)

eq (Equal)
ne (Not equal)
in (In)

createdTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

updatedTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

Partner endpoints

Organizations

Fields you can filter with

Available operators

id

eq (Equal)
ne (Not equal)
in (In)

archived

eq (Equal)
ne (Not equal)

createdTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

updatedTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

User roles

Fields you can filter with

Available operators

id

eq (Equal)
ne (Not equal)
in (In)

type

eq (Equal)
ne (Not equal)

createdTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

updatedTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

Users

Fields you can filter with

Available operators

id

eq (Equal)
ne (Not equal)
in (In)

archived

eq (Equal)
ne (Not equal)

role.type

eq (Equal)
ne (Not equal)
in (In)

createdTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

updatedTime

gt (Greater than)
gte (Greater than or equal)
lt (Less than)
lte (Less than or equal)

Updated 7 days ago