Invoice Create
CertifiedCreate an invoice
Invoice Create
Create an invoice
Write operation: creates a new invoice in the QuickBooks company (POST /invoice). Running the task twice creates two invoices. A retry after a timeout can also create a duplicate when QuickBooks processed the first request, so set requestId to make the call idempotent.
The invoice body needs at least CustomerRef and one Line.
type: io.kestra.plugin.quickbooks.invoices.CreateExamples
Create an invoice with one sales line
id: create_invoice
namespace: company.team
tasks:
- id: create
type: io.kestra.plugin.quickbooks.invoices.Create
clientId: "{{ secret('QBO_CLIENT_ID') }}"
clientSecret: "{{ secret('QBO_CLIENT_SECRET') }}"
refreshToken: "{{ secret('QBO_REFRESH_TOKEN') }}"
realmId: "{{ secret('QBO_REALM_ID') }}"
requestId: "{{ execution.id }}-{{ taskrun.id }}"
invoice:
CustomerRef:
value: "58"
Line:
- Amount: 150.0
DetailType: SalesItemLineDetail
SalesItemLineDetail:
ItemRef:
value: "1"
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.
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.
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.
requestId string
Request ID (idempotency key)
Sent as the QuickBooks requestid query parameter, at most 50 characters. QuickBooks returns the result of the first request instead of creating a second invoice when it receives the same requestid again, which protects against duplicates when a retry follows a timeout. Use a value that is stable across the attempts of one run, for example {{ execution.id }}-{{ taskrun.id }}. Without it, a retry after a timeout can create a duplicate invoice.
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.
