Invoice List

Invoice List

Certified

List Invoice records

Builds select * from Invoice where ... from the typed filters and the optional raw where, all combined with AND. Values are escaped, so a filter cannot alter the rest of the query.

yaml
type: io.kestra.plugin.quickbooks.invoices.List

List Invoice records

yaml
id: list_invoices
namespace: company.team
tasks:
  - id: list
    type: io.kestra.plugin.quickbooks.invoices.List
    clientId: "{{ secret('QBO_CLIENT_ID') }}"
    clientSecret: "{{ secret('QBO_CLIENT_SECRET') }}"
    refreshToken: "{{ secret('QBO_REFRESH_TOKEN') }}"
    realmId: "{{ secret('QBO_REALM_ID') }}"
    fetchType: FETCH

List the overdue invoices of a customer above a minimum balance

yaml
id: list_overdue_invoices
namespace: company.team
tasks:
  - id: list
    type: io.kestra.plugin.quickbooks.invoices.List
    clientId: "{{ secret('QBO_CLIENT_ID') }}"
    clientSecret: "{{ secret('QBO_CLIENT_SECRET') }}"
    refreshToken: "{{ secret('QBO_REFRESH_TOKEN') }}"
    realmId: "{{ secret('QBO_REALM_ID') }}"
    customerId: "58"
    status: OVERDUE
    dueAfter: "2026-10-01"
    balanceMin: 100
    fetchType: STORE
Properties

QuickBooks Client ID

The OAuth2 Client ID for your QuickBooks application

QuickBooks Client Secret

The OAuth2 Client Secret for your QuickBooks application

QuickBooks Realm ID

The Realm ID (Company ID) for the QuickBooks account. Digits only, checked after rendering.

QuickBooks Refresh Token

A valid OAuth2 refresh token. Kestra will automatically rotate and persist it in the KV Store. Note: Token rotation is not cross-worker concurrency safe, and failed KV store writes may result in lost tokens.

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Defaulthttps://oauth.platform.intuit.com/oauth2/v1/tokens/bearer

Authentication URL

The OAuth2 token endpoint. Must be an intuit.com domain.

Minimum balance

Only invoices with Balance greater than or equal to this amount.

Defaulthttps://quickbooks.api.intuit.com

Base URL

The Base URL for QuickBooks API. Must be an intuit.com domain. Defaults to production.

Only invoices of this customer

The customer id, matched against CustomerRef.

Due after

Only invoices with DueDate strictly after this date (yyyy-MM-dd).

Due before

Only invoices with DueDate strictly before this date (yyyy-MM-dd).

DefaultSTORE
Possible Values
STOREFETCHFETCH_ONENONE

The way to consume the results

FETCH stores results in memory (useful for small datasets). STORE saves them as an internal storage file (mandatory for large datasets).

Default75

Minor Version

The minor version of the QuickBooks API to use. Must be 1 or more, checked after rendering.

Possible Values
OPENOVERDUEPAID

Invoice status

One of OPEN (Balance > 0), OVERDUE (Balance > 0 and DueDate before today, UTC) or PAID (Balance = 0). Values are uppercase and case-sensitive.

Transaction date from

Only invoices with TxnDate on or after this date (yyyy-MM-dd).

Transaction date to

Only invoices with TxnDate on or before this date (yyyy-MM-dd).

Only records updated since

Keeps records whose MetaData.LastUpdatedTime is greater than or equal to this ISO 8601 instant, for example 2026-01-01T00: 00: 00Z. Sub-second precision is dropped.

Optional WHERE clause to filter records

Raw QuickBooks query condition, for example Balance > '0'. It is sent as is, so escape any value you build from untrusted input yourself (a single quote is written \'). It is combined with the typed filters using AND (QuickBooks queries have no OR).

Map containing the first row of fetched data.

Only populated if using fetchType=FETCH_ONE.

List containing the fetched data.

Only populated if using fetchType=FETCH.

The number of fetched rows.

Formaturi

Kestra's internal storage URI of the stored data.

Only populated if using fetchType=STORE.

More Plugins in this Category

Firecrawl
Firecrawl

Tasks that scrape and crawl websites into clean, LLM-ready content with Firecrawl.

Data

2 tasks

Liquibase
Liquibase

Tasks that run Liquibase change management commands.

Data

2 tasks

8 blueprints