Invoice Update
CertifiedUpdate an invoice
Invoice Update
Update an invoice
Write operation: modifies an existing invoice (POST /invoice). With sparse: true (default) only the fields in invoice change. With sparse: false QuickBooks performs a full update: every writable field you omit is reset, so send the complete invoice.
syncToken must be the current one, otherwise QuickBooks rejects the update as stale. Read it with invoices.Get first, or reuse the syncToken output of a previous write.
type: io.kestra.plugin.quickbooks.invoices.UpdateExamples
Change the private note of an invoice with a sparse update
id: update_invoice
namespace: company.team
tasks:
- id: update
type: io.kestra.plugin.quickbooks.invoices.Update
clientId: "{{ secret('QBO_CLIENT_ID') }}"
clientSecret: "{{ secret('QBO_CLIENT_SECRET') }}"
refreshToken: "{{ secret('QBO_REFRESH_TOKEN') }}"
realmId: "{{ secret('QBO_REALM_ID') }}"
invoiceId: "130"
syncToken: "2"
invoice:
PrivateNote: "Reviewed by finance"
Properties
clientId *string
QuickBooks Client ID
The OAuth2 Client ID for your QuickBooks application
clientSecret *string
QuickBooks Client Secret
The OAuth2 Client Secret for your QuickBooks application
invoice *object
Invoice body
The QuickBooks Invoice object as a map, using QuickBooks field names (CustomerRef, Line, ...). See https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/invoice.
invoiceId *string
Invoice ID
The QuickBooks Id of the invoice to update. It overrides any Id in invoice.
realmId *string
QuickBooks Realm ID
The Realm ID (Company ID) for the QuickBooks account. Digits only, checked after rendering.
refreshToken *string
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.
syncToken *string
Sync token
The current SyncToken of the invoice, used by QuickBooks for optimistic locking. It overrides any SyncToken in invoice.
assets
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.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset 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.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150authUrl string
https://oauth.platform.intuit.com/oauth2/v1/tokens/bearerAuthentication URL
The OAuth2 token endpoint. Must be an intuit.com domain.
baseUrl string
https://quickbooks.api.intuit.comBase URL
The Base URL for QuickBooks API. Must be an intuit.com domain. Defaults to production.
minorVersion integerstring
75Minor Version
The minor version of the QuickBooks API to use. Must be 1 or more, checked after rendering.
sparse booleanstring
trueSparse update
When true, only the fields given in invoice are updated.
Outputs
id string
Invoice ID
The Id of the invoice.
row object
The invoice
The created or updated invoice as returned by QuickBooks.
syncToken string
Sync token
The new SyncToken, required for the next update of this invoice.
totalAmt number
Total amount
The TotalAmt of the invoice.
