QuickBooks

Connect one QuickBooks Online company per credential. Create an app in the Intuit Developer Portal, register https://<your-sim-host>/api/auth/oauth2/callback/quickbooks as its redirect URI, then enter that app's client ID, client secret, and webhook verifier token in Sim and select its Sandbox or Production environment. Sim encrypts this app configuration on the credential and uses it for authorization, refresh, revocation, and webhook signature verification.

During OAuth, choose the company that the workflow should access. Intuit returns the realm ID in the callback, and Sim verifies that the issued token can read CompanyInfo through that company-scoped API path before binding it to the credential, so you do not enter a realm ID or API host. The CompanyInfo.Id field is a separate entity ID and is not used as the realm ID.

Master Data, Sales, and Purchasing transaction reads support List and By ID modes. List actions return at most one page. Use nextStartPosition in another workflow step when hasMore is true. Sim does not paginate, retry, or fetch related records automatically.

QuickBooks update actions require the record ID and its current SyncToken; provide only the fields you want to change. Sim uses Intuit's documented sparse-update mode where the entity supports it, and otherwise reads the current entity, merges the requested fields, and submits a full update. Use the latest SyncToken returned by a read or mutation. Voiding keeps the transaction in QuickBooks with a zeroed financial effect; it is not deletion and requires explicit confirmation. Create actions accept an optional requestId that QuickBooks uses for idempotency when the same request may be submitted again.

Sandbox credentials call only Intuit's sandbox API and are suitable for disposable test data. Production credentials call the production API and affect the selected live company.

QuickBooks triggers use Intuit's app-level webhook model. After adding a trigger and deploying the workflow once, copy the generated Webhook URL from the block into the matching Development or Production Webhooks settings for the same Intuit app. Enable the CloudEvents payload format and select every entity and operation needed by your deployed workflows. One Intuit endpoint can serve multiple connected companies; Sim verifies the raw-body intuit-signature with that app's encrypted verifier token and routes each event by both Intuit app and OAuth-derived realm ID.

Run Financial Report exposes verified financial statements, aging, balance, sales, and expense reports while preserving QuickBooks' native columns and nested rows. Advanced controls appear only where QuickBooks supports them. Use Read Master Data to discover customer, vendor, account, item, class, and department IDs for report filters. Intuit recommends report periods of six months or less for performance, though Sim does not forbid longer accounting periods.

Document actions can read attachment metadata, add one File or Note attachment, download an attachment file, and download supported transactions as PDFs. Downloaded files are stored as Sim files for downstream blocks. Attachment deletion, bulk upload/download, and bulk email remain outside this version of the block.

Usage Instructions

Connect one QuickBooks Online company to manage bounded master-data, sales, purchasing, receivables, payables, accounting, reports, transaction delivery, and document workflows.

Actions

QuickBooks Get Company Info

Get information about the connected QuickBooks Online company

Input

ParameterTypeRequiredDescription

Output

ParameterTypeDescription
companyjsonVerified QuickBooks CompanyInfo object with tax identifiers removed
IdstringQuickBooks CompanyInfo entity ID (commonly "1"); this is not the OAuth realmId
SyncTokenstringCompanyInfo sync token
CompanyNamestringCompany display name
LegalNamestringCompany legal name
CompanyAddrjsonCompany address
CustomerCommunicationAddrjsonCustomer communication address
LegalAddrjsonCompany legal address
PrimaryPhonejsonPrimary phone details
EmailjsonCompany email details
WebAddrjsonCompany website details
CompanyStartDatestringCompany start date
CountrystringCompany country code
FiscalYearStartMonthstringFiscal year starting month
SupportedLanguagesstringComma-separated list of languages supported by the company
domainstringOriginating Intuit domain
sparsebooleanWhether QuickBooks returned a partial representation
NameValuearrayQuickBooks company settings represented as name/value entries
MetaDatajsonCompanyInfo creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
timestringQuickBooks response timestamp

QuickBooks Read Master Data

List or read one account, class, customer, department, employee, item, or vendor

Input

ParameterTypeRequiredDescription
recordTypestringYesMaster-data entity to read: account, class, customer, department, employee, item, or vendor
readModestringYesWhether to list records or read one record by ID
recordIdstringNoQuickBooks record ID, required for by-ID reads
startPositionnumberNoOne-based position of the first list record to return
maxResultsnumberNoNumber of list records to request (1–100)
activeStatusstringNoList records using the QuickBooks default, active, or inactive status

Output

ParameterTypeDescription
recordTypestringMaster-data record type returned by this action
itemjsonSingle QuickBooks master-data record returned by a by-ID read
IdstringQuickBooks entity ID
SyncTokenstringEntity sync token
ActivebooleanWhether the entity is active
MetaDatajsonEntity creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
NamestringAccount, item, class, or department name
SubAccountbooleanWhether this is a subaccount
ParentRefjsonParent account, item, class, or department reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
FullyQualifiedNamestringHierarchical qualified account, item, class, or department name
ClassificationstringAccount classification
AccountTypestringAccount type
AccountSubTypestringAccount subtype
CurrentBalancenumberAccount current balance
CurrencyRefjsonAccount, customer, or vendor currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
DisplayNamestringCustomer, vendor, or employee display name
CompanyNamestringCustomer or vendor company name
GivenNamestringGiven name
FamilyNamestringFamily name
TaxablebooleanTaxable status for the customer or item
PrimaryEmailAddrjsonCustomer, vendor, or employee primary email address
PrimaryPhonejsonCustomer, vendor, or employee primary phone number
BillAddrjsonCustomer or vendor billing address
ShipAddrjsonCustomer shipping address
BalancenumberCustomer or vendor balance
PrintOnCheckNamestringVendor or employee name printed on checks
Vendor1099booleanWhether the vendor is tracked for 1099 reporting
AcctNumstringVendor account number
DescriptionstringItem sales description
UnitPricenumberItem sale price
TypestringItem type
IncomeAccountRefjsonItem income account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
ExpenseAccountRefjsonItem expense account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PurchaseDescstringItem purchase description
PurchaseCostnumberItem purchase cost
AssetAccountRefjsonInventory asset account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
TrackQtyOnHandbooleanWhether QuickBooks tracks quantity on hand
QtyOnHandnumberCurrent quantity on hand
InvStartDatestringInventory tracking start date
PrimaryAddrjsonEmployee primary address
BillableTimebooleanWhether employee time is billable
domainstringQuickBooks domain
sparsebooleanWhether this is a sparse entity
SubClassbooleanWhether the Class is nested under another Class
SubDepartmentbooleanWhether the Department is nested under another Department
itemsarrayQuickBooks master-data records returned by a list read
IdstringQuickBooks entity ID
SyncTokenstringEntity sync token
ActivebooleanWhether the entity is active
MetaDatajsonEntity creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
NamestringAccount, item, class, or department name
SubAccountbooleanWhether this is a subaccount
ParentRefjsonParent account, item, class, or department reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
FullyQualifiedNamestringHierarchical qualified account, item, class, or department name
ClassificationstringAccount classification
AccountTypestringAccount type
AccountSubTypestringAccount subtype
CurrentBalancenumberAccount current balance
CurrencyRefjsonAccount, customer, or vendor currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
DisplayNamestringCustomer, vendor, or employee display name
CompanyNamestringCustomer or vendor company name
GivenNamestringGiven name
FamilyNamestringFamily name
TaxablebooleanTaxable status for the customer or item
PrimaryEmailAddrjsonCustomer, vendor, or employee primary email address
PrimaryPhonejsonCustomer, vendor, or employee primary phone number
BillAddrjsonCustomer or vendor billing address
ShipAddrjsonCustomer shipping address
BalancenumberCustomer or vendor balance
PrintOnCheckNamestringVendor or employee name printed on checks
Vendor1099booleanWhether the vendor is tracked for 1099 reporting
AcctNumstringVendor account number
DescriptionstringItem sales description
UnitPricenumberItem sale price
TypestringItem type
IncomeAccountRefjsonItem income account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
ExpenseAccountRefjsonItem expense account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PurchaseDescstringItem purchase description
PurchaseCostnumberItem purchase cost
AssetAccountRefjsonInventory asset account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
TrackQtyOnHandbooleanWhether QuickBooks tracks quantity on hand
QtyOnHandnumberCurrent quantity on hand
InvStartDatestringInventory tracking start date
PrimaryAddrjsonEmployee primary address
BillableTimebooleanWhether employee time is billable
domainstringQuickBooks domain
sparsebooleanWhether this is a sparse entity
SubClassbooleanWhether the Class is nested under another Class
SubDepartmentbooleanWhether the Department is nested under another Department
recordVersionstringDisplay-safe alias for the native SyncToken on a by-ID record
startPositionnumberOne-based position of the first record in this page
maxResultsnumberActual number of records returned in this page
nextStartPositionnumberPosition to use when explicitly requesting the next page
hasMorebooleanConservative indication that another page may exist
timestringQuickBooks response timestamp

QuickBooks Create Customer

Create a customer in the connected QuickBooks Online company

Input

ParameterTypeRequiredDescription
displayNamestringNoUnique customer display name. Required unless givenName or familyName is supplied
companyNamestringNoCustomer company name
givenNamestringNoCustomer given name
familyNamestringNoCustomer family name
primaryEmailstringNoCustomer primary email address
primaryPhonestringNoCustomer primary phone number
billingAddressjsonNoCustomer billing address
shippingAddressjsonNoCustomer shipping address
taxablebooleanNoWhether sales to this customer are taxable
requestIdstringNoOptional Intuit idempotency request ID, up to 50 characters

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonCreated QuickBooks Customer record
IdstringQuickBooks entity ID
SyncTokenstringEntity sync token
ActivebooleanWhether the entity is active
MetaDatajsonEntity creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
DisplayNamestringCustomer display name
CompanyNamestringCustomer company name
GivenNamestringGiven name
FamilyNamestringFamily name
TaxablebooleanWhether the customer is taxable
PrimaryEmailAddrjsonCustomer primary email address
PrimaryPhonejsonCustomer primary phone number
BillAddrjsonCustomer billing address
ShipAddrjsonCustomer shipping address
BalancenumberCustomer balance
CurrencyRefjsonCustomer currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name

QuickBooks Update Customer

Sparse-update a customer in the connected QuickBooks Online company

Input

ParameterTypeRequiredDescription
customerIdstringYesID of the customer to update
syncTokenstringYesCurrent customer sync token
displayNamestringNoReplacement customer display name
companyNamestringNoReplacement customer company name
givenNamestringNoReplacement customer given name
familyNamestringNoReplacement customer family name
primaryEmailstringNoReplacement primary email address
primaryPhonestringNoReplacement primary phone number
billingAddressjsonNoReplacement billing address
shippingAddressjsonNoReplacement shipping address
taxablebooleanNoWhether sales to this customer are taxable
activeStatusstringNoCustomer status change: unchanged, active, or inactive

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonUpdated QuickBooks Customer record
IdstringQuickBooks entity ID
SyncTokenstringEntity sync token
ActivebooleanWhether the entity is active
MetaDatajsonEntity creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
DisplayNamestringCustomer display name
CompanyNamestringCustomer company name
GivenNamestringGiven name
FamilyNamestringFamily name
TaxablebooleanWhether the customer is taxable
PrimaryEmailAddrjsonCustomer primary email address
PrimaryPhonejsonCustomer primary phone number
BillAddrjsonCustomer billing address
ShipAddrjsonCustomer shipping address
BalancenumberCustomer balance
CurrencyRefjsonCustomer currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name

QuickBooks Create Employee

Create a non-payroll employee profile in the connected QuickBooks Online company

Input

ParameterTypeRequiredDescription
displayNamestringNoUnique employee display name. When omitted QuickBooks derives it from the supplied name components, and it is read-only when QuickBooks Payroll is enabled
givenNamestringNoEmployee given name. At least one of givenName or familyName is required
familyNamestringNoEmployee family name. At least one of givenName or familyName is required
primaryEmailstringNoEmployee primary email address
primaryPhonestringNoEmployee primary phone number
primaryAddressjsonNoEmployee primary address
printOnCheckNamestringNoEmployee name printed on checks
billableTimebooleanNoWhether employee time is billable
requestIdstringNoOptional Intuit idempotency request ID, up to 50 characters

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonCreated QuickBooks Employee record
IdstringQuickBooks entity ID
SyncTokenstringEntity sync token
ActivebooleanWhether the entity is active
MetaDatajsonEntity creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
DisplayNamestringEmployee display name
GivenNamestringGiven name
FamilyNamestringFamily name
PrintOnCheckNamestringEmployee name printed on checks
PrimaryEmailAddrjsonEmployee primary email address
PrimaryPhonejsonEmployee primary phone number
PrimaryAddrjsonEmployee primary address
BillableTimebooleanWhether employee time is billable
domainstringQuickBooks domain
sparsebooleanWhether this is a sparse entity

QuickBooks Update Employee

Read, merge, and full-update a non-payroll employee profile

Input

ParameterTypeRequiredDescription
employeeIdstringYesID of the employee to update
syncTokenstringYesCurrent employee sync token
displayNamestringNoReplacement employee display name
givenNamestringNoReplacement employee given name
familyNamestringNoReplacement employee family name
primaryEmailstringNoReplacement employee primary email address
primaryPhonestringNoReplacement employee primary phone number
primaryAddressjsonNoReplacement employee primary address
printOnCheckNamestringNoReplacement employee name printed on checks
billableTimebooleanNoWhether employee time is billable
activeStatusstringNoEmployee status change: unchanged, active, or inactive

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonUpdated QuickBooks Employee record
IdstringQuickBooks entity ID
SyncTokenstringEntity sync token
ActivebooleanWhether the entity is active
MetaDatajsonEntity creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
DisplayNamestringEmployee display name
GivenNamestringGiven name
FamilyNamestringFamily name
PrintOnCheckNamestringEmployee name printed on checks
PrimaryEmailAddrjsonEmployee primary email address
PrimaryPhonejsonEmployee primary phone number
PrimaryAddrjsonEmployee primary address
BillableTimebooleanWhether employee time is billable
domainstringQuickBooks domain
sparsebooleanWhether this is a sparse entity

QuickBooks Create Vendor

Create a vendor in the connected QuickBooks Online company

Input

ParameterTypeRequiredDescription
displayNamestringNoUnique vendor display name. Required unless givenName or familyName is supplied
companyNamestringNoVendor company name
givenNamestringNoVendor given name
familyNamestringNoVendor family name
primaryEmailstringNoVendor primary email address
primaryPhonestringNoVendor primary phone number
billingAddressjsonNoVendor billing address
printOnCheckNamestringNoName to print on checks
accountNumberstringNoVendor account number
vendor1099booleanNoWhether the vendor is tracked for 1099 reporting
requestIdstringNoOptional Intuit idempotency request ID, up to 50 characters

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonCreated QuickBooks Vendor record
IdstringQuickBooks entity ID
SyncTokenstringEntity sync token
ActivebooleanWhether the entity is active
MetaDatajsonEntity creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
DisplayNamestringVendor display name
CompanyNamestringVendor company name
GivenNamestringGiven name
FamilyNamestringFamily name
PrintOnCheckNamestringName printed on checks
Vendor1099booleanWhether the vendor is tracked for 1099 reporting
PrimaryEmailAddrjsonVendor primary email address
PrimaryPhonejsonVendor primary phone number
BillAddrjsonVendor billing address
AcctNumstringVendor account number
BalancenumberVendor balance
CurrencyRefjsonVendor currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name

QuickBooks Update Vendor

Read, merge, and full-update a vendor in QuickBooks Online

Input

ParameterTypeRequiredDescription
vendorIdstringYesID of the vendor to update
syncTokenstringYesCurrent vendor sync token
displayNamestringNoReplacement vendor display name
companyNamestringNoReplacement vendor company name
givenNamestringNoReplacement vendor given name
familyNamestringNoReplacement vendor family name
primaryEmailstringNoReplacement primary email address
primaryPhonestringNoReplacement primary phone number
billingAddressjsonNoReplacement billing address
printOnCheckNamestringNoReplacement name to print on checks
accountNumberstringNoReplacement vendor account number
vendor1099booleanNoWhether the vendor is tracked for 1099 reporting
activeStatusstringNoVendor status change: unchanged, active, or inactive

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonUpdated QuickBooks Vendor record
IdstringQuickBooks entity ID
SyncTokenstringEntity sync token
ActivebooleanWhether the entity is active
MetaDatajsonEntity creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
DisplayNamestringVendor display name
CompanyNamestringVendor company name
GivenNamestringGiven name
FamilyNamestringFamily name
PrintOnCheckNamestringName printed on checks
Vendor1099booleanWhether the vendor is tracked for 1099 reporting
PrimaryEmailAddrjsonVendor primary email address
PrimaryPhonejsonVendor primary phone number
BillAddrjsonVendor billing address
AcctNumstringVendor account number
BalancenumberVendor balance
CurrencyRefjsonVendor currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name

QuickBooks Create Item

Create a Service or Non-inventory item in QuickBooks Online

Input

ParameterTypeRequiredDescription
namestringYesUnique item name
itemTypestringYesWritable item type: service or non_inventory
incomeAccountIdstringNoSales of Product Income account ID recording proceeds from the sale. Intuit requires it for Service items except in France locales
descriptionstringNoSales description
unitPricenumberNoSales price per unit
purchaseDescriptionstringNoPurchase description
purchaseCostnumberNoPurchase cost per unit
expenseAccountIdstringNoCost of Goods Sold account ID used to pay the vendor for this item. Intuit requires it for Service and Non-inventory items except in France locales
taxablebooleanNoWhether the item is taxable
requestIdstringNoOptional Intuit idempotency request ID, up to 50 characters

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonCreated QuickBooks Item record
IdstringQuickBooks entity ID
SyncTokenstringEntity sync token
ActivebooleanWhether the entity is active
MetaDatajsonEntity creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
NamestringItem name
DescriptionstringItem sales description
FullyQualifiedNamestringHierarchical qualified item name
TaxablebooleanWhether the item is taxable
UnitPricenumberItem sale price
TypestringItem type
IncomeAccountRefjsonItem income account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
ExpenseAccountRefjsonItem expense account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PurchaseDescstringItem purchase description
PurchaseCostnumberItem purchase cost
AssetAccountRefjsonInventory asset account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
TrackQtyOnHandbooleanWhether QuickBooks tracks quantity on hand
QtyOnHandnumberCurrent quantity on hand
InvStartDatestringInventory tracking start date
ParentRefjsonParent item or category reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name

QuickBooks Update Item

Read, merge, and full-update an item without changing its type

Input

ParameterTypeRequiredDescription
itemIdstringYesID of the item to update
syncTokenstringYesCurrent item sync token
namestringNoReplacement item name
incomeAccountIdstringNoReplacement income account ID
descriptionstringNoReplacement sales description
unitPricenumberNoReplacement sales price per unit
purchaseDescriptionstringNoReplacement purchase description
purchaseCostnumberNoReplacement purchase cost per unit
expenseAccountIdstringNoReplacement expense account ID
taxablebooleanNoWhether the item is taxable
activeStatusstringNoItem status change: unchanged, active, or inactive

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonUpdated QuickBooks Item record
IdstringQuickBooks entity ID
SyncTokenstringEntity sync token
ActivebooleanWhether the entity is active
MetaDatajsonEntity creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
NamestringItem name
DescriptionstringItem sales description
FullyQualifiedNamestringHierarchical qualified item name
TaxablebooleanWhether the item is taxable
UnitPricenumberItem sale price
TypestringItem type
IncomeAccountRefjsonItem income account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
ExpenseAccountRefjsonItem expense account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PurchaseDescstringItem purchase description
PurchaseCostnumberItem purchase cost
AssetAccountRefjsonInventory asset account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
TrackQtyOnHandbooleanWhether QuickBooks tracks quantity on hand
QtyOnHandnumberCurrent quantity on hand
InvStartDatestringInventory tracking start date
ParentRefjsonParent item or category reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name

QuickBooks Read Sales Transactions

List or read one estimate, invoice, sales receipt, payment, credit memo, or refund receipt

Input

ParameterTypeRequiredDescription
transactionTypestringYesSales transaction type to read
readModestringYesWhether to list transactions or read one transaction by ID
transactionIdstringNoQuickBooks transaction ID, required for by-ID reads
startPositionnumberNoOne-based position of the first list record to return
maxResultsnumberNoNumber of list records to request (1–100)
startDatestringNoList transactions on or after this date in YYYY-MM-DD format
endDatestringNoList transactions on or before this date in YYYY-MM-DD format
customerIdstringNoList transactions for one QuickBooks customer ID

Output

ParameterTypeDescription
transactionTypestringSales transaction type returned
itemjsonSingle native QuickBooks sales transaction
IdstringQuickBooks sales transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringInvoice due date
ExpirationDatestringEstimate expiration date
CustomerRefjsonCustomer reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
CustomerMemojsonCustomer-facing memo
DepositToAccountRefjsonDeposit account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentMethodRefjsonPayment method reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentRefNumstringCustomer payment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks transaction lines
LinkedTxnarrayTransactions linked by QuickBooks
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
UnappliedAmtnumberUnapplied payment amount
PrivateNotestringInternal transaction note
TxnStatusstringTransaction status
TxnTaxDetailjsonCalculated tax details
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
itemsarrayNative QuickBooks sales transactions
IdstringQuickBooks sales transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringInvoice due date
ExpirationDatestringEstimate expiration date
CustomerRefjsonCustomer reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
CustomerMemojsonCustomer-facing memo
DepositToAccountRefjsonDeposit account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentMethodRefjsonPayment method reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentRefNumstringCustomer payment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks transaction lines
LinkedTxnarrayTransactions linked by QuickBooks
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
UnappliedAmtnumberUnapplied payment amount
PrivateNotestringInternal transaction note
TxnStatusstringTransaction status
TxnTaxDetailjsonCalculated tax details
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
recordVersionstringDisplay-safe alias for the native SyncToken on a by-ID transaction
startPositionnumberOne-based position of the first item in this response
maxResultsnumberActual number of items reported for this response
nextStartPositionnumberPosition to use when explicitly requesting the next page
hasMorebooleanConservative indication that another page may exist
timestringQuickBooks response timestamp

QuickBooks Create Estimate

Create an estimate with bounded item and description lines

Input

ParameterTypeRequiredDescription
customerIdstringYesCustomer receiving the estimate
linesjsonYesBounded item and description lines
transactionDatestringNoEstimate date in YYYY-MM-DD format
expirationDatestringNoEstimate expiration date in YYYY-MM-DD format
documentNumberstringNoOptional estimate number
privateNotestringNoInternal estimate note
customerMemostringNoCustomer-facing estimate memo
requestIdstringNoOptional Intuit idempotency request ID, up to 50 characters

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonCreated native QuickBooks Estimate
IdstringQuickBooks sales transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringInvoice due date
ExpirationDatestringEstimate expiration date
CustomerRefjsonCustomer reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
CustomerMemojsonCustomer-facing memo
DepositToAccountRefjsonDeposit account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentMethodRefjsonPayment method reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentRefNumstringCustomer payment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks transaction lines
LinkedTxnarrayTransactions linked by QuickBooks
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
UnappliedAmtnumberUnapplied payment amount
PrivateNotestringInternal transaction note
TxnStatusstringTransaction status
TxnTaxDetailjsonCalculated tax details
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Update Estimate

Sparse-update an estimate using its current sync token

Input

ParameterTypeRequiredDescription
transactionIdstringYesEstimate ID to update
syncTokenstringYesCurrent estimate sync token
customerIdstringNoReplacement customer ID
linesjsonNoComplete replacement set of estimate lines: any existing line omitted here is deleted from the estimate
transactionDatestringNoReplacement estimate date in YYYY-MM-DD format
expirationDatestringNoReplacement expiration date in YYYY-MM-DD format
documentNumberstringNoReplacement estimate number
privateNotestringNoReplacement internal note
customerMemostringNoReplacement customer-facing memo

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonUpdated native QuickBooks Estimate
IdstringQuickBooks sales transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringInvoice due date
ExpirationDatestringEstimate expiration date
CustomerRefjsonCustomer reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
CustomerMemojsonCustomer-facing memo
DepositToAccountRefjsonDeposit account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentMethodRefjsonPayment method reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentRefNumstringCustomer payment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks transaction lines
LinkedTxnarrayTransactions linked by QuickBooks
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
UnappliedAmtnumberUnapplied payment amount
PrivateNotestringInternal transaction note
TxnStatusstringTransaction status
TxnTaxDetailjsonCalculated tax details
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Create Invoice

Create an invoice without emailing or collecting payment

Input

ParameterTypeRequiredDescription
customerIdstringYesCustomer receiving the invoice
linesjsonYesBounded item and description lines
transactionDatestringNoInvoice date in YYYY-MM-DD format
dueDatestringNoInvoice due date in YYYY-MM-DD format
documentNumberstringNoOptional invoice number
privateNotestringNoInternal invoice note
customerMemostringNoCustomer-facing invoice memo
requestIdstringNoOptional Intuit idempotency request ID, up to 50 characters

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonCreated native QuickBooks Invoice
IdstringQuickBooks sales transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringInvoice due date
ExpirationDatestringEstimate expiration date
CustomerRefjsonCustomer reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
CustomerMemojsonCustomer-facing memo
DepositToAccountRefjsonDeposit account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentMethodRefjsonPayment method reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentRefNumstringCustomer payment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks transaction lines
LinkedTxnarrayTransactions linked by QuickBooks
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
UnappliedAmtnumberUnapplied payment amount
PrivateNotestringInternal transaction note
TxnStatusstringTransaction status
TxnTaxDetailjsonCalculated tax details
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Update Invoice

Sparse-update an invoice using its current sync token

Input

ParameterTypeRequiredDescription
transactionIdstringYesInvoice ID to update
syncTokenstringYesCurrent invoice sync token
customerIdstringNoReplacement customer ID
linesjsonNoComplete replacement set of invoice lines: any existing line omitted here is deleted from the invoice
transactionDatestringNoReplacement invoice date in YYYY-MM-DD format
dueDatestringNoReplacement due date in YYYY-MM-DD format
documentNumberstringNoReplacement invoice number
privateNotestringNoReplacement internal note
customerMemostringNoReplacement customer-facing memo

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonUpdated native QuickBooks Invoice
IdstringQuickBooks sales transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringInvoice due date
ExpirationDatestringEstimate expiration date
CustomerRefjsonCustomer reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
CustomerMemojsonCustomer-facing memo
DepositToAccountRefjsonDeposit account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentMethodRefjsonPayment method reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentRefNumstringCustomer payment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks transaction lines
LinkedTxnarrayTransactions linked by QuickBooks
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
UnappliedAmtnumberUnapplied payment amount
PrivateNotestringInternal transaction note
TxnStatusstringTransaction status
TxnTaxDetailjsonCalculated tax details
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Void Invoice

Void an invoice after explicit confirmation

Input

ParameterTypeRequiredDescription
transactionIdstringYesInvoice ID to void
syncTokenstringYesCurrent invoice sync token
confirmVoidbooleanYesExplicit confirmation that the invoice should be voided

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
voidedbooleanWhether QuickBooks voided the transaction
recordjsonVoided native QuickBooks Invoice
IdstringQuickBooks sales transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringInvoice due date
ExpirationDatestringEstimate expiration date
CustomerRefjsonCustomer reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
CustomerMemojsonCustomer-facing memo
DepositToAccountRefjsonDeposit account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentMethodRefjsonPayment method reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentRefNumstringCustomer payment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks transaction lines
LinkedTxnarrayTransactions linked by QuickBooks
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
UnappliedAmtnumberUnapplied payment amount
PrivateNotestringInternal transaction note
TxnStatusstringTransaction status
TxnTaxDetailjsonCalculated tax details
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Create Sales Receipt

Create a sales receipt for a completed customer sale

Input

ParameterTypeRequiredDescription
customerIdstringYesCustomer for the sales receipt
linesjsonYesBounded item and description lines
transactionDatestringNoSales receipt date in YYYY-MM-DD format
documentNumberstringNoOptional sales receipt number
privateNotestringNoInternal sales receipt note
customerMemostringNoCustomer-facing sales receipt memo
paymentMethodIdstringNoQuickBooks payment method ID
paymentReferenceNumberstringNoPayment reference number
depositAccountIdstringNoQuickBooks deposit account ID
requestIdstringNoOptional Intuit idempotency request ID, up to 50 characters

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonCreated native QuickBooks SalesReceipt
IdstringQuickBooks sales transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringInvoice due date
ExpirationDatestringEstimate expiration date
CustomerRefjsonCustomer reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
CustomerMemojsonCustomer-facing memo
DepositToAccountRefjsonDeposit account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentMethodRefjsonPayment method reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentRefNumstringCustomer payment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks transaction lines
LinkedTxnarrayTransactions linked by QuickBooks
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
UnappliedAmtnumberUnapplied payment amount
PrivateNotestringInternal transaction note
TxnStatusstringTransaction status
TxnTaxDetailjsonCalculated tax details
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Update Sales Receipt

Sparse-update a sales receipt using its current sync token

Input

ParameterTypeRequiredDescription
transactionIdstringYesSales receipt ID to update
syncTokenstringYesCurrent sales receipt sync token
customerIdstringNoReplacement customer ID
linesjsonNoComplete replacement set of sales receipt lines: any existing line omitted here is deleted from the sales receipt
transactionDatestringNoReplacement receipt date in YYYY-MM-DD format
documentNumberstringNoReplacement sales receipt number
privateNotestringNoReplacement internal note
customerMemostringNoReplacement customer-facing memo
paymentMethodIdstringNoReplacement payment method ID
paymentReferenceNumberstringNoReplacement payment reference number
depositAccountIdstringNoReplacement deposit account ID

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonUpdated native QuickBooks SalesReceipt
IdstringQuickBooks sales transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringInvoice due date
ExpirationDatestringEstimate expiration date
CustomerRefjsonCustomer reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
CustomerMemojsonCustomer-facing memo
DepositToAccountRefjsonDeposit account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentMethodRefjsonPayment method reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentRefNumstringCustomer payment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks transaction lines
LinkedTxnarrayTransactions linked by QuickBooks
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
UnappliedAmtnumberUnapplied payment amount
PrivateNotestringInternal transaction note
TxnStatusstringTransaction status
TxnTaxDetailjsonCalculated tax details
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Create Customer Payment

Record a customer payment with optional bounded invoice allocations

Input

ParameterTypeRequiredDescription
customerIdstringYesCustomer making the payment
totalAmountnumberYesPositive total payment amount
transactionDatestringNoPayment date in YYYY-MM-DD format
privateNotestringNoInternal payment note
paymentReferenceNumberstringNoPayment reference number such as a check number
paymentMethodIdstringNoQuickBooks payment method ID
depositAccountIdstringNoQuickBooks deposit account ID
invoiceAllocationsjsonNoUp to 100 invoice allocations with invoiceId and positive amount
requestIdstringNoOptional Intuit idempotency request ID, up to 50 characters

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonCreated native QuickBooks Payment
IdstringQuickBooks sales transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringInvoice due date
ExpirationDatestringEstimate expiration date
CustomerRefjsonCustomer reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
CustomerMemojsonCustomer-facing memo
DepositToAccountRefjsonDeposit account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentMethodRefjsonPayment method reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentRefNumstringCustomer payment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks transaction lines
LinkedTxnarrayTransactions linked by QuickBooks
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
UnappliedAmtnumberUnapplied payment amount
PrivateNotestringInternal transaction note
TxnStatusstringTransaction status
TxnTaxDetailjsonCalculated tax details
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Update Customer Payment

Read, merge, and full-update a customer payment using its current sync token

Input

ParameterTypeRequiredDescription
paymentIdstringYesPayment ID to update
syncTokenstringYesCurrent payment sync token
customerIdstringNoReplacement customer ID
totalAmountnumberNoReplacement positive payment total
transactionDatestringNoReplacement payment date in YYYY-MM-DD format
privateNotestringNoReplacement internal note
paymentReferenceNumberstringNoReplacement payment reference number
paymentMethodIdstringNoReplacement payment method ID
depositAccountIdstringNoReplacement deposit account ID
invoiceAllocationsjsonNoBounded invoice allocations to apply. Each entry sets the amount applied to that invoice; invoices already applied on the payment and not listed here keep their current amounts
unapplyOmittedInvoicesbooleanNoReplace the payment allocations outright. Requires a non-empty invoiceAllocations list; every invoice not listed is UNAPPLIED and returns to open

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonUpdated native QuickBooks Payment
IdstringQuickBooks sales transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringInvoice due date
ExpirationDatestringEstimate expiration date
CustomerRefjsonCustomer reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
CustomerMemojsonCustomer-facing memo
DepositToAccountRefjsonDeposit account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentMethodRefjsonPayment method reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentRefNumstringCustomer payment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks transaction lines
LinkedTxnarrayTransactions linked by QuickBooks
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
UnappliedAmtnumberUnapplied payment amount
PrivateNotestringInternal transaction note
TxnStatusstringTransaction status
TxnTaxDetailjsonCalculated tax details
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Void Customer Payment

Void a customer payment after explicit confirmation

Input

ParameterTypeRequiredDescription
transactionIdstringYesPayment ID to void
syncTokenstringYesCurrent payment sync token
confirmVoidbooleanYesExplicit confirmation that the payment should be voided

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
voidedbooleanWhether QuickBooks voided the transaction
recordjsonVoided native QuickBooks Payment
IdstringQuickBooks sales transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringInvoice due date
ExpirationDatestringEstimate expiration date
CustomerRefjsonCustomer reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
CustomerMemojsonCustomer-facing memo
DepositToAccountRefjsonDeposit account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentMethodRefjsonPayment method reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentRefNumstringCustomer payment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks transaction lines
LinkedTxnarrayTransactions linked by QuickBooks
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
UnappliedAmtnumberUnapplied payment amount
PrivateNotestringInternal transaction note
TxnStatusstringTransaction status
TxnTaxDetailjsonCalculated tax details
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Create Credit Memo

Create a customer credit memo with bounded sales lines

Input

ParameterTypeRequiredDescription
customerIdstringYesCustomer receiving the credit memo
linesjsonYesBounded item and description lines
transactionDatestringNoCredit memo date in YYYY-MM-DD format
documentNumberstringNoOptional credit memo number
privateNotestringNoInternal credit memo note
customerMemostringNoCustomer-facing credit memo memo
requestIdstringNoOptional Intuit idempotency request ID, up to 50 characters

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonCreated native QuickBooks CreditMemo
IdstringQuickBooks sales transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringInvoice due date
ExpirationDatestringEstimate expiration date
CustomerRefjsonCustomer reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
CustomerMemojsonCustomer-facing memo
DepositToAccountRefjsonDeposit account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentMethodRefjsonPayment method reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentRefNumstringCustomer payment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks transaction lines
LinkedTxnarrayTransactions linked by QuickBooks
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
UnappliedAmtnumberUnapplied payment amount
PrivateNotestringInternal transaction note
TxnStatusstringTransaction status
TxnTaxDetailjsonCalculated tax details
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Update Credit Memo

Read, merge, and full-update a credit memo using its current sync token

Input

ParameterTypeRequiredDescription
transactionIdstringYesCredit memo ID to update
syncTokenstringYesCurrent credit memo sync token
customerIdstringNoReplacement customer ID
linesjsonNoComplete replacement set of credit memo lines: any existing line omitted here is deleted from the credit memo
transactionDatestringNoReplacement credit memo date in YYYY-MM-DD format
documentNumberstringNoReplacement credit memo number
privateNotestringNoReplacement internal note
customerMemostringNoReplacement customer-facing memo

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonUpdated native QuickBooks CreditMemo
IdstringQuickBooks sales transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringInvoice due date
ExpirationDatestringEstimate expiration date
CustomerRefjsonCustomer reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
CustomerMemojsonCustomer-facing memo
DepositToAccountRefjsonDeposit account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentMethodRefjsonPayment method reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentRefNumstringCustomer payment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks transaction lines
LinkedTxnarrayTransactions linked by QuickBooks
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
UnappliedAmtnumberUnapplied payment amount
PrivateNotestringInternal transaction note
TxnStatusstringTransaction status
TxnTaxDetailjsonCalculated tax details
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Create Refund Receipt

Create a customer refund receipt against a required deposit account

Input

ParameterTypeRequiredDescription
customerIdstringYesCustomer receiving the refund
linesjsonYesBounded item and description lines
depositAccountIdstringYesQuickBooks bank account funding the refund
transactionDatestringNoRefund receipt date in YYYY-MM-DD format
documentNumberstringNoOptional refund receipt number
privateNotestringNoInternal refund receipt note
customerMemostringNoCustomer-facing refund memo
paymentMethodIdstringNoQuickBooks payment method ID
paymentReferenceNumberstringNoRefund payment reference number
requestIdstringNoOptional Intuit idempotency request ID, up to 50 characters

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonCreated native QuickBooks RefundReceipt
IdstringQuickBooks sales transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringInvoice due date
ExpirationDatestringEstimate expiration date
CustomerRefjsonCustomer reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
CustomerMemojsonCustomer-facing memo
DepositToAccountRefjsonDeposit account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentMethodRefjsonPayment method reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentRefNumstringCustomer payment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks transaction lines
LinkedTxnarrayTransactions linked by QuickBooks
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
UnappliedAmtnumberUnapplied payment amount
PrivateNotestringInternal transaction note
TxnStatusstringTransaction status
TxnTaxDetailjsonCalculated tax details
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Update Refund Receipt

Read, merge, and full-update a refund receipt using its current sync token

Input

ParameterTypeRequiredDescription
transactionIdstringYesRefund receipt ID to update
syncTokenstringYesCurrent refund receipt sync token
customerIdstringNoReplacement customer ID
linesjsonNoComplete replacement set of refund receipt lines: any existing line omitted here is deleted from the refund receipt
transactionDatestringNoReplacement refund date in YYYY-MM-DD format
documentNumberstringNoReplacement refund receipt number
privateNotestringNoReplacement internal note
customerMemostringNoReplacement customer-facing memo
paymentMethodIdstringNoReplacement payment method ID
paymentReferenceNumberstringNoReplacement payment reference number
depositAccountIdstringNoReplacement deposit account ID

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonUpdated native QuickBooks RefundReceipt
IdstringQuickBooks sales transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringInvoice due date
ExpirationDatestringEstimate expiration date
CustomerRefjsonCustomer reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
CustomerMemojsonCustomer-facing memo
DepositToAccountRefjsonDeposit account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentMethodRefjsonPayment method reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentRefNumstringCustomer payment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks transaction lines
LinkedTxnarrayTransactions linked by QuickBooks
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
UnappliedAmtnumberUnapplied payment amount
PrivateNotestringInternal transaction note
TxnStatusstringTransaction status
TxnTaxDetailjsonCalculated tax details
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Read Purchasing Transactions

List or read one purchase order, bill, bill payment, vendor credit, or purchase

Input

ParameterTypeRequiredDescription
transactionTypestringYesPurchasing transaction type to read
readModestringYesWhether to list transactions or read one transaction by ID
transactionIdstringNoQuickBooks transaction ID, required for by-ID reads
startPositionnumberNoOne-based position of the first list record to return
maxResultsnumberNoNumber of list records to request (1–100)
startDatestringNoList transactions on or after this date in YYYY-MM-DD format
endDatestringNoList transactions on or before this date in YYYY-MM-DD format
vendorIdstringNoList transactions for one supported QuickBooks vendor ID

Output

ParameterTypeDescription
transactionTypestringPurchasing transaction type returned
itemjsonSingle native QuickBooks purchasing transaction
IdstringQuickBooks purchasing transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringBill due date
VendorRefjsonVendor reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
APAccountRefjsonAccounts-payable account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
AccountRefjsonPayment account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
EntityRefjsonPurchase payee reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
typestringReferenced entity type
PaymentTypestringPurchase payment type
PayTypestringBill-payment type
CheckPaymentjsonCheck payment account details
CreditCardPaymentjsonCredit-card payment account details
PaymentRefNumstringPayment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks expense or allocation lines
IdstringQuickBooks transaction line ID
LineNumnumberQuickBooks transaction line number
DescriptionstringTransaction line description
AmountnumberTransaction line amount
DetailTypestringQuickBooks line detail type
LinkedTxnarrayTransactions linked to this QuickBooks line
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
AccountBasedExpenseLineDetailjsonNative QuickBooks account-based expense details
ItemBasedExpenseLineDetailjsonNative QuickBooks item-based expense details
LinkedTxnarrayTransactions linked by QuickBooks
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
PrivateNotestringInternal transaction note
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
itemsarrayNative QuickBooks purchasing transactions
IdstringQuickBooks purchasing transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringBill due date
VendorRefjsonVendor reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
APAccountRefjsonAccounts-payable account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
AccountRefjsonPayment account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
EntityRefjsonPurchase payee reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
typestringReferenced entity type
PaymentTypestringPurchase payment type
PayTypestringBill-payment type
CheckPaymentjsonCheck payment account details
CreditCardPaymentjsonCredit-card payment account details
PaymentRefNumstringPayment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks expense or allocation lines
IdstringQuickBooks transaction line ID
LineNumnumberQuickBooks transaction line number
DescriptionstringTransaction line description
AmountnumberTransaction line amount
DetailTypestringQuickBooks line detail type
LinkedTxnarrayTransactions linked to this QuickBooks line
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
AccountBasedExpenseLineDetailjsonNative QuickBooks account-based expense details
ItemBasedExpenseLineDetailjsonNative QuickBooks item-based expense details
LinkedTxnarrayTransactions linked by QuickBooks
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
PrivateNotestringInternal transaction note
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
recordVersionstringDisplay-safe alias for the native SyncToken on a by-ID transaction
startPositionnumberOne-based position of the first item in this response
maxResultsnumberActual number of items reported for this response
nextStartPositionnumberPosition to use when explicitly requesting the next page
hasMorebooleanConservative indication that another page may exist
timestringQuickBooks response timestamp

QuickBooks Create Purchase Order

Create a purchase order with bounded expense lines

Input

ParameterTypeRequiredDescription
vendorIdstringYesPurchase-order vendor ID
apAccountIdstringYesAccounts-payable account ID
linesjsonYesBounded account-based or item-based expense lines
transactionDatestringNoPurchase-order date in YYYY-MM-DD format
documentNumberstringNoOptional purchase-order number
privateNotestringNoInternal purchase-order note
requestIdstringNoOptional Intuit idempotency request ID, up to 50 characters

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonCreated native QuickBooks PurchaseOrder
IdstringQuickBooks purchasing transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringBill due date
VendorRefjsonVendor reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
APAccountRefjsonAccounts-payable account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
AccountRefjsonPayment account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
EntityRefjsonPurchase payee reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
typestringReferenced entity type
PaymentTypestringPurchase payment type
PayTypestringBill-payment type
CheckPaymentjsonCheck payment account details
CreditCardPaymentjsonCredit-card payment account details
PaymentRefNumstringPayment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks expense or allocation lines
IdstringQuickBooks transaction line ID
LineNumnumberQuickBooks transaction line number
DescriptionstringTransaction line description
AmountnumberTransaction line amount
DetailTypestringQuickBooks line detail type
LinkedTxnarrayTransactions linked to this QuickBooks line
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
AccountBasedExpenseLineDetailjsonNative QuickBooks account-based expense details
ItemBasedExpenseLineDetailjsonNative QuickBooks item-based expense details
LinkedTxnarrayTransactions linked by QuickBooks
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
PrivateNotestringInternal transaction note
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Update Purchase Order

Read, merge, and full-update purchase-order header fields

Input

ParameterTypeRequiredDescription
purchaseOrderIdstringYesPurchase Order ID to update
syncTokenstringYesCurrent purchase-order sync token
vendorIdstringNoReplacement vendor ID
apAccountIdstringNoReplacement accounts-payable account ID
transactionDatestringNoReplacement date in YYYY-MM-DD format
documentNumberstringNoReplacement purchase-order number
privateNotestringNoReplacement internal note

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonUpdated native QuickBooks PurchaseOrder
IdstringQuickBooks purchasing transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringBill due date
VendorRefjsonVendor reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
APAccountRefjsonAccounts-payable account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
AccountRefjsonPayment account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
EntityRefjsonPurchase payee reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
typestringReferenced entity type
PaymentTypestringPurchase payment type
PayTypestringBill-payment type
CheckPaymentjsonCheck payment account details
CreditCardPaymentjsonCredit-card payment account details
PaymentRefNumstringPayment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks expense or allocation lines
IdstringQuickBooks transaction line ID
LineNumnumberQuickBooks transaction line number
DescriptionstringTransaction line description
AmountnumberTransaction line amount
DetailTypestringQuickBooks line detail type
LinkedTxnarrayTransactions linked to this QuickBooks line
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
AccountBasedExpenseLineDetailjsonNative QuickBooks account-based expense details
ItemBasedExpenseLineDetailjsonNative QuickBooks item-based expense details
LinkedTxnarrayTransactions linked by QuickBooks
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
PrivateNotestringInternal transaction note
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Create Bill

Create a vendor bill with optional Purchase Order line links without paying it

Input

ParameterTypeRequiredDescription
vendorIdstringYesBill vendor ID
linesjsonYesBounded account-based or item-based expense lines with optional paired Purchase Order and line IDs
apAccountIdstringNoOptional accounts-payable account ID
transactionDatestringNoBill date in YYYY-MM-DD format
dueDatestringNoBill due date in YYYY-MM-DD format
documentNumberstringNoOptional bill number
privateNotestringNoInternal bill note
requestIdstringNoOptional Intuit idempotency request ID, up to 50 characters

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
linkingRequestedbooleanWhether any Purchase Order line links were requested
linkingSucceededbooleanWhether QuickBooks returned every requested Purchase Order line link
linkedLinesarrayRequested Purchase Order line links confirmed by QuickBooks
purchaseOrderIdstringRequested Purchase Order ID
purchaseOrderLineIdstringRequested Purchase Order line ID
billLineIdstringCreated Bill line ID carrying the confirmed link
missingLinksarrayRequested Purchase Order line links omitted by QuickBooks
purchaseOrderIdstringRequested Purchase Order ID
purchaseOrderLineIdstringRequested Purchase Order line ID
linkingWarningstringWarning that the Bill was created without every requested Purchase Order link
recordjsonCreated native QuickBooks Bill
IdstringQuickBooks purchasing transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringBill due date
VendorRefjsonVendor reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
APAccountRefjsonAccounts-payable account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
AccountRefjsonPayment account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
EntityRefjsonPurchase payee reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
typestringReferenced entity type
PaymentTypestringPurchase payment type
PayTypestringBill-payment type
CheckPaymentjsonCheck payment account details
CreditCardPaymentjsonCredit-card payment account details
PaymentRefNumstringPayment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks expense or allocation lines
IdstringQuickBooks transaction line ID
LineNumnumberQuickBooks transaction line number
DescriptionstringTransaction line description
AmountnumberTransaction line amount
DetailTypestringQuickBooks line detail type
LinkedTxnarrayTransactions linked to this QuickBooks line
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
AccountBasedExpenseLineDetailjsonNative QuickBooks account-based expense details
ItemBasedExpenseLineDetailjsonNative QuickBooks item-based expense details
LinkedTxnarrayTransactions linked by QuickBooks
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
PrivateNotestringInternal transaction note
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Update Bill

Read, merge, and full-update bill header fields using its current sync token

Input

ParameterTypeRequiredDescription
billIdstringYesBill ID to update
syncTokenstringYesCurrent bill sync token
vendorIdstringNoReplacement vendor ID; omit to preserve the current vendor
apAccountIdstringNoReplacement accounts-payable account ID
transactionDatestringNoReplacement bill date in YYYY-MM-DD format
dueDatestringNoReplacement due date in YYYY-MM-DD format
documentNumberstringNoReplacement bill number
privateNotestringNoReplacement internal note

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonUpdated native QuickBooks Bill
IdstringQuickBooks purchasing transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringBill due date
VendorRefjsonVendor reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
APAccountRefjsonAccounts-payable account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
AccountRefjsonPayment account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
EntityRefjsonPurchase payee reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
typestringReferenced entity type
PaymentTypestringPurchase payment type
PayTypestringBill-payment type
CheckPaymentjsonCheck payment account details
CreditCardPaymentjsonCredit-card payment account details
PaymentRefNumstringPayment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks expense or allocation lines
IdstringQuickBooks transaction line ID
LineNumnumberQuickBooks transaction line number
DescriptionstringTransaction line description
AmountnumberTransaction line amount
DetailTypestringQuickBooks line detail type
LinkedTxnarrayTransactions linked to this QuickBooks line
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
AccountBasedExpenseLineDetailjsonNative QuickBooks account-based expense details
ItemBasedExpenseLineDetailjsonNative QuickBooks item-based expense details
LinkedTxnarrayTransactions linked by QuickBooks
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
PrivateNotestringInternal transaction note
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Create Bill Payment

Record a check or credit-card payment allocated to one or more bills

Input

ParameterTypeRequiredDescription
vendorIdstringYesVendor whose bills are being paid
totalAmountnumberYesPositive total payment amount
paymentTypestringYesCheck or credit-card payment type
paymentAccountIdstringYesBank or credit-card account ID matching the payment type
billAllocationsjsonNoOptional bounded Bill-only allocations; any unallocated amount becomes vendor credit
transactionDatestringNoPayment date in YYYY-MM-DD format
privateNotestringNoInternal payment note
requestIdstringNoOptional Intuit idempotency request ID, up to 50 characters

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonCreated native QuickBooks BillPayment
IdstringQuickBooks purchasing transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringBill due date
VendorRefjsonVendor reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
APAccountRefjsonAccounts-payable account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
AccountRefjsonPayment account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
EntityRefjsonPurchase payee reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
typestringReferenced entity type
PaymentTypestringPurchase payment type
PayTypestringBill-payment type
CheckPaymentjsonCheck payment account details
CreditCardPaymentjsonCredit-card payment account details
PaymentRefNumstringPayment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks expense or allocation lines
IdstringQuickBooks transaction line ID
LineNumnumberQuickBooks transaction line number
DescriptionstringTransaction line description
AmountnumberTransaction line amount
DetailTypestringQuickBooks line detail type
LinkedTxnarrayTransactions linked to this QuickBooks line
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
AccountBasedExpenseLineDetailjsonNative QuickBooks account-based expense details
ItemBasedExpenseLineDetailjsonNative QuickBooks item-based expense details
LinkedTxnarrayTransactions linked by QuickBooks
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
PrivateNotestringInternal transaction note
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Update Bill Payment

Read, merge, and full-update a BillPayment without changing allocations

Input

ParameterTypeRequiredDescription
billPaymentIdstringYesBillPayment ID to update
syncTokenstringYesCurrent BillPayment sync token
vendorIdstringNoReplacement vendor ID; omit to preserve the current vendor
transactionDatestringNoReplacement payment date in YYYY-MM-DD format
privateNotestringNoReplacement internal note

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonUpdated native QuickBooks BillPayment
IdstringQuickBooks purchasing transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringBill due date
VendorRefjsonVendor reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
APAccountRefjsonAccounts-payable account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
AccountRefjsonPayment account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
EntityRefjsonPurchase payee reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
typestringReferenced entity type
PaymentTypestringPurchase payment type
PayTypestringBill-payment type
CheckPaymentjsonCheck payment account details
CreditCardPaymentjsonCredit-card payment account details
PaymentRefNumstringPayment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks expense or allocation lines
IdstringQuickBooks transaction line ID
LineNumnumberQuickBooks transaction line number
DescriptionstringTransaction line description
AmountnumberTransaction line amount
DetailTypestringQuickBooks line detail type
LinkedTxnarrayTransactions linked to this QuickBooks line
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
AccountBasedExpenseLineDetailjsonNative QuickBooks account-based expense details
ItemBasedExpenseLineDetailjsonNative QuickBooks item-based expense details
LinkedTxnarrayTransactions linked by QuickBooks
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
PrivateNotestringInternal transaction note
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Create Vendor Credit

Create a vendor credit without applying it to a bill

Input

ParameterTypeRequiredDescription
vendorIdstringYesVendor issuing the credit
linesjsonYesBounded account-based or item-based expense lines
apAccountIdstringNoOptional accounts-payable account ID
transactionDatestringNoCredit date in YYYY-MM-DD format
documentNumberstringNoOptional vendor-credit number
privateNotestringNoInternal vendor-credit note
requestIdstringNoOptional Intuit idempotency request ID, up to 50 characters

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonCreated native QuickBooks VendorCredit
IdstringQuickBooks purchasing transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringBill due date
VendorRefjsonVendor reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
APAccountRefjsonAccounts-payable account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
AccountRefjsonPayment account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
EntityRefjsonPurchase payee reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
typestringReferenced entity type
PaymentTypestringPurchase payment type
PayTypestringBill-payment type
CheckPaymentjsonCheck payment account details
CreditCardPaymentjsonCredit-card payment account details
PaymentRefNumstringPayment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks expense or allocation lines
IdstringQuickBooks transaction line ID
LineNumnumberQuickBooks transaction line number
DescriptionstringTransaction line description
AmountnumberTransaction line amount
DetailTypestringQuickBooks line detail type
LinkedTxnarrayTransactions linked to this QuickBooks line
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
AccountBasedExpenseLineDetailjsonNative QuickBooks account-based expense details
ItemBasedExpenseLineDetailjsonNative QuickBooks item-based expense details
LinkedTxnarrayTransactions linked by QuickBooks
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
PrivateNotestringInternal transaction note
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Update Vendor Credit

Read, merge, and full-update vendor-credit header fields

Input

ParameterTypeRequiredDescription
vendorCreditIdstringYesVendorCredit ID to update
syncTokenstringYesCurrent vendor-credit sync token
vendorIdstringNoReplacement vendor ID; omit to preserve the current vendor
apAccountIdstringNoReplacement accounts-payable account ID
transactionDatestringNoReplacement date in YYYY-MM-DD format
documentNumberstringNoReplacement vendor-credit number
privateNotestringNoReplacement internal note

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonUpdated native QuickBooks VendorCredit
IdstringQuickBooks purchasing transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringBill due date
VendorRefjsonVendor reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
APAccountRefjsonAccounts-payable account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
AccountRefjsonPayment account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
EntityRefjsonPurchase payee reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
typestringReferenced entity type
PaymentTypestringPurchase payment type
PayTypestringBill-payment type
CheckPaymentjsonCheck payment account details
CreditCardPaymentjsonCredit-card payment account details
PaymentRefNumstringPayment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks expense or allocation lines
IdstringQuickBooks transaction line ID
LineNumnumberQuickBooks transaction line number
DescriptionstringTransaction line description
AmountnumberTransaction line amount
DetailTypestringQuickBooks line detail type
LinkedTxnarrayTransactions linked to this QuickBooks line
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
AccountBasedExpenseLineDetailjsonNative QuickBooks account-based expense details
ItemBasedExpenseLineDetailjsonNative QuickBooks item-based expense details
LinkedTxnarrayTransactions linked by QuickBooks
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
PrivateNotestringInternal transaction note
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Create Purchase

Record a cash, check, or credit-card purchase with bounded expense lines

Input

ParameterTypeRequiredDescription
paymentTypestringYesCash, check, or credit-card purchase type
paymentAccountIdstringYesBank or credit-card account ID matching the purchase type
linesjsonYesBounded account-based or item-based expense lines
vendorIdstringNoOptional vendor payee ID
transactionDatestringNoPurchase date in YYYY-MM-DD format
paymentReferencestringNoOptional transaction reference number, such as a check number, sent as the purchase DocNumber
privateNotestringNoInternal purchase note
requestIdstringNoOptional Intuit idempotency request ID, up to 50 characters

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonCreated native QuickBooks Purchase
IdstringQuickBooks purchasing transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringBill due date
VendorRefjsonVendor reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
APAccountRefjsonAccounts-payable account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
AccountRefjsonPayment account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
EntityRefjsonPurchase payee reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
typestringReferenced entity type
PaymentTypestringPurchase payment type
PayTypestringBill-payment type
CheckPaymentjsonCheck payment account details
CreditCardPaymentjsonCredit-card payment account details
PaymentRefNumstringPayment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks expense or allocation lines
IdstringQuickBooks transaction line ID
LineNumnumberQuickBooks transaction line number
DescriptionstringTransaction line description
AmountnumberTransaction line amount
DetailTypestringQuickBooks line detail type
LinkedTxnarrayTransactions linked to this QuickBooks line
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
AccountBasedExpenseLineDetailjsonNative QuickBooks account-based expense details
ItemBasedExpenseLineDetailjsonNative QuickBooks item-based expense details
LinkedTxnarrayTransactions linked by QuickBooks
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
PrivateNotestringInternal transaction note
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Update Purchase

Read, merge, and full-update purchase header fields without changing lines

Input

ParameterTypeRequiredDescription
purchaseIdstringYesPurchase ID to update
syncTokenstringYesCurrent purchase sync token
vendorIdstringNoReplacement vendor payee ID
transactionDatestringNoReplacement purchase date in YYYY-MM-DD format
paymentReferencestringNoReplacement transaction reference number, such as a check number, sent as the purchase DocNumber
privateNotestringNoReplacement internal note

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonUpdated native QuickBooks Purchase
IdstringQuickBooks purchasing transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringBill due date
VendorRefjsonVendor reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
APAccountRefjsonAccounts-payable account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
AccountRefjsonPayment account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
EntityRefjsonPurchase payee reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
typestringReferenced entity type
PaymentTypestringPurchase payment type
PayTypestringBill-payment type
CheckPaymentjsonCheck payment account details
CreditCardPaymentjsonCredit-card payment account details
PaymentRefNumstringPayment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks expense or allocation lines
IdstringQuickBooks transaction line ID
LineNumnumberQuickBooks transaction line number
DescriptionstringTransaction line description
AmountnumberTransaction line amount
DetailTypestringQuickBooks line detail type
LinkedTxnarrayTransactions linked to this QuickBooks line
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
AccountBasedExpenseLineDetailjsonNative QuickBooks account-based expense details
ItemBasedExpenseLineDetailjsonNative QuickBooks item-based expense details
LinkedTxnarrayTransactions linked by QuickBooks
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
PrivateNotestringInternal transaction note
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Read Accounting Transactions

List or read one journal entry, deposit, or transfer

Input

ParameterTypeRequiredDescription
transactionTypestringYesAccounting transaction type to read
readModestringYesWhether to list transactions or read one transaction by ID
transactionIdstringNoQuickBooks transaction ID, required for by-ID reads
startPositionnumberNoOne-based position of the first list record to return
maxResultsnumberNoNumber of list records to request (1–100)
startDatestringNoList transactions on or after this date in YYYY-MM-DD format
endDatestringNoList transactions on or before this date in YYYY-MM-DD format

Output

ParameterTypeDescription
transactionTypestringAccounting transaction type returned
itemjsonSingle native QuickBooks accounting transaction
IdstringQuickBooks accounting transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
PrivateNotestringInternal transaction note
AdjustmentbooleanWhether the journal entry is an adjusting entry
DepositToAccountRefjsonAccount receiving a deposit
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
FromAccountRefjsonTransfer source account
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
ToAccountRefjsonTransfer destination account
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks journal or deposit lines
AmountnumberTransfer amount
TotalAmtnumberTransaction total amount
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
itemsarrayNative QuickBooks accounting transactions
IdstringQuickBooks accounting transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
PrivateNotestringInternal transaction note
AdjustmentbooleanWhether the journal entry is an adjusting entry
DepositToAccountRefjsonAccount receiving a deposit
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
FromAccountRefjsonTransfer source account
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
ToAccountRefjsonTransfer destination account
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks journal or deposit lines
AmountnumberTransfer amount
TotalAmtnumberTransaction total amount
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
recordVersionstringDisplay-safe alias for the native SyncToken on a by-ID transaction
startPositionnumberOne-based position of the first item in this response
maxResultsnumberActual number of items reported for this response
nextStartPositionnumberPosition to use when explicitly requesting the next page
hasMorebooleanConservative indication that another page may exist
timestringQuickBooks response timestamp

QuickBooks Create Journal Entry

Post a balanced journal entry after explicit confirmation

Input

ParameterTypeRequiredDescription
linesjsonYesTwo to 100 balanced debit and credit lines
confirmPostingbooleanYesExplicit confirmation that this journal entry should be posted
transactionDatestringNoJournal-entry date in YYYY-MM-DD format
documentNumberstringNoOptional journal-entry number
privateNotestringNoInternal journal-entry note
requestIdstringNoOptional Intuit idempotency request ID, up to 50 characters

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonCreated native QuickBooks JournalEntry
IdstringQuickBooks accounting transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
PrivateNotestringInternal transaction note
AdjustmentbooleanWhether the journal entry is an adjusting entry
DepositToAccountRefjsonAccount receiving a deposit
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
FromAccountRefjsonTransfer source account
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
ToAccountRefjsonTransfer destination account
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks journal or deposit lines
AmountnumberTransfer amount
TotalAmtnumberTransaction total amount
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Update Journal Entry

Sparse-update journal-entry header fields after explicit confirmation

Input

ParameterTypeRequiredDescription
journalEntryIdstringYesJournal Entry ID to update
syncTokenstringYesCurrent journal-entry sync token
confirmPostingbooleanYesExplicit confirmation that this journal-entry update should be posted
transactionDatestringNoReplacement date in YYYY-MM-DD format
documentNumberstringNoReplacement journal-entry number
privateNotestringNoReplacement internal note

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonUpdated native QuickBooks JournalEntry
IdstringQuickBooks accounting transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
PrivateNotestringInternal transaction note
AdjustmentbooleanWhether the journal entry is an adjusting entry
DepositToAccountRefjsonAccount receiving a deposit
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
FromAccountRefjsonTransfer source account
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
ToAccountRefjsonTransfer destination account
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks journal or deposit lines
AmountnumberTransfer amount
TotalAmtnumberTransaction total amount
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Create Deposit

Create a deposit with bounded account lines

Input

ParameterTypeRequiredDescription
depositAccountIdstringYesBank or asset account receiving the deposit
linesjsonYesOne to 100 account-based deposit lines
transactionDatestringNoDeposit date in YYYY-MM-DD format
privateNotestringNoInternal deposit note
requestIdstringNoOptional Intuit idempotency request ID, up to 50 characters

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonCreated native QuickBooks Deposit
IdstringQuickBooks accounting transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
PrivateNotestringInternal transaction note
AdjustmentbooleanWhether the journal entry is an adjusting entry
DepositToAccountRefjsonAccount receiving a deposit
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
FromAccountRefjsonTransfer source account
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
ToAccountRefjsonTransfer destination account
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks journal or deposit lines
AmountnumberTransfer amount
TotalAmtnumberTransaction total amount
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Update Deposit

Sparse-update deposit header fields using the current sync token and destination account

Input

ParameterTypeRequiredDescription
depositIdstringYesDeposit ID to update
syncTokenstringYesCurrent deposit sync token
depositAccountIdstringYesCurrent QuickBooks account receiving the deposit
transactionDatestringNoReplacement date in YYYY-MM-DD format
privateNotestringNoReplacement internal note

Output

ParameterTypeDescription
recordIdstringID of the created or updated QuickBooks entity
syncTokenstringNative QuickBooks SyncToken returned by the mutation
recordVersionstringLatest QuickBooks record version required for a subsequent update; this is the native SyncToken under a display-safe name
timestringQuickBooks response timestamp
recordjsonUpdated native QuickBooks Deposit
IdstringQuickBooks accounting transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
PrivateNotestringInternal transaction note
AdjustmentbooleanWhether the journal entry is an adjusting entry
DepositToAccountRefjsonAccount receiving a deposit
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
FromAccountRefjsonTransfer source account
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
ToAccountRefjsonTransfer destination account
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks journal or deposit lines
AmountnumberTransfer amount
TotalAmtnumberTransaction total amount
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp

QuickBooks Run Financial Report

Run a fixed QuickBooks financial report with verified accountant-focused filters

Input

ParameterTypeRequiredDescription
reportTypestringYesFixed QuickBooks financial report to run
startDatestringNoReport start date in YYYY-MM-DD format; Intuit recommends periods of six months or less for performance
endDatestringNoReport end or as-of date in YYYY-MM-DD format
accountingMethodstringNoUse the QuickBooks default, cash basis, or accrual basis
summarizeBystringNoTime period or business dimension used to summarize report columns
customerIdstringNoSingle QuickBooks customer ID filter
vendorIdstringNoSingle QuickBooks vendor ID filter
accountIdstringNoSingle QuickBooks account ID filter
itemIdstringNoSingle QuickBooks item ID filter
classIdstringNoSingle QuickBooks class ID filter
departmentIdstringNoSingle QuickBooks department ID filter
agingMethodstringNoAge open balances from the report date or current date
agingDaysnumberNoPositive number of days in each aging period
transactionTypestringNoTransaction type filter for Transaction List
groupBystringNoGrouping dimension for Transaction List
accountsPayablePaidstringNoAccounts-payable paid status for Transaction List
accountsReceivablePaidstringNoAccounts-receivable paid status for Transaction List
clearedStatusstringNoCleared status filter for Transaction List
documentNumberstringNoDocument number filter for Transaction List
sourceAccountTypestringNoSource account type filter for Transaction List

Output

ParameterTypeDescription
reportTypestringFinancial report type that was run
headerjsonNative QuickBooks report header with name, periods, basis, currency, summarization, filters, and options
TimestringQuickBooks report generation timestamp
ReportNamestringNative QuickBooks report name
DateMacrostringQuickBooks date macro, when returned
ReportBasisstringCash or accrual basis
StartPeriodstringReport start date
EndPeriodstringReport end or as-of date
SummarizeColumnsBystringDimension or time period used for report columns
CurrencystringReport currency
CustomerstringApplied customer filter
VendorstringApplied vendor filter
AccountstringApplied account filter
ItemstringApplied item filter
ClassstringApplied class filter
DepartmentstringApplied department filter
OptionarrayNative QuickBooks report options, including no-data indicators when present
columnsjsonNative QuickBooks report column definitions
ColumnarrayNative report column definitions with titles, types, and metadata
ColTitlestringColumn title
ColTypestringQuickBooks column data type
MetaDataarrayNative column metadata name/value entries
rowsjsonNative hierarchical QuickBooks report rows and section summaries
RowarrayNative hierarchical report rows; section rows may contain Header, nested Rows, and Summary, while data rows contain ColData values, IDs, and links
typestringQuickBooks row type
groupstringQuickBooks section group
HeaderjsonSection header column data
ColDataarrayRow values with optional operational IDs and links
RowsjsonNested native QuickBooks report rows
SummaryjsonSection summary column data
timestringQuickBooks response timestamp

QuickBooks Email Transaction

Send a supported QuickBooks transaction by email. This causes an external email and Intuit limits sandbox email delivery.

Input

ParameterTypeRequiredDescription
transactionTypestringYesSupported transaction type to email
transactionIdstringYesQuickBooks transaction ID
recipientstringNoRequired for Customer Payments; otherwise an optional single recipient override
confirmSendbooleanYesExplicit confirmation that an external email should be sent

Output

ParameterTypeDescription
transactionTypestringEmailed QuickBooks transaction type
transactionIdstringEmailed QuickBooks transaction ID
sentbooleanWhether QuickBooks accepted the email send request
recordjsonNative QuickBooks transaction returned after sending
IdstringQuickBooks transaction ID
SyncTokenstringCurrent transaction sync token
DocNumberstringTransaction document number
TxnDatestringTransaction date
DueDatestringTransaction due date
ExpirationDatestringEstimate expiration date
CustomerRefjsonCustomer reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
CustomerMemojsonCustomer-facing memo
DepositToAccountRefjsonDeposit account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentMethodRefjsonPayment method reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
PaymentRefNumstringPayment reference number
CurrencyRefjsonTransaction currency reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
LinearrayNative QuickBooks sales or purchasing transaction lines
IdstringQuickBooks transaction line ID
LineNumnumberQuickBooks transaction line number
DescriptionstringTransaction line description
AmountnumberTransaction line amount
DetailTypestringQuickBooks line detail type
LinkedTxnarrayTransactions linked to this QuickBooks line
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
AccountBasedExpenseLineDetailjsonNative QuickBooks account-based expense details
ItemBasedExpenseLineDetailjsonNative QuickBooks item-based expense details
SalesItemLineDetailjsonNative QuickBooks sales item line details
DescriptionLineDetailjsonNative QuickBooks description line details
LinkedTxnarrayTransactions linked by QuickBooks
TxnIdstringLinked QuickBooks transaction ID
TxnTypestringLinked QuickBooks transaction type
TxnLineIdstringLinked QuickBooks transaction line ID
TotalAmtnumberTransaction total amount
BalancenumberRemaining transaction balance
UnappliedAmtnumberUnapplied payment amount
PrivateNotestringInternal transaction note
TxnStatusstringTransaction status
TxnTaxDetailjsonCalculated tax details
MetaDatajsonTransaction creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
VendorRefjsonVendor reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
APAccountRefjsonAccounts-payable account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
AccountRefjsonPayment account reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
EntityRefjsonPurchase payee reference
valuestringQuickBooks entity ID
namestringQuickBooks entity display name
typestringReferenced entity type
PaymentTypestringPurchase payment type
PayTypestringBill-payment type
CheckPaymentjsonCheck payment account details
CreditCardPaymentjsonCredit-card payment account details
POStatusstringPurchase order status
timestringQuickBooks response timestamp

QuickBooks Download Transaction PDF

Download a supported QuickBooks transaction as a bounded PDF file

Input

ParameterTypeRequiredDescription
transactionTypestringYesSupported transaction type to download
transactionIdstringYesQuickBooks transaction ID
fileNamestringNoOptional safe PDF filename override

Output

ParameterTypeDescription
filefileDownloaded file stored in execution files
fileNamestringSafe downloaded filename
mimeTypestringDownloaded file MIME type
sizenumberDownloaded file size in bytes
transactionTypestringDownloaded QuickBooks transaction type
transactionIdstringDownloaded QuickBooks transaction ID

QuickBooks Read Attachments

List attachment metadata for a fixed QuickBooks entity or read one attachment by ID

Input

ParameterTypeRequiredDescription
readModestringYesRead mode: list or by_id
targetTypestringNoFixed QuickBooks entity type for List mode
targetIdstringNoQuickBooks entity ID for List mode
attachmentIdstringNoQuickBooks attachment ID for By ID mode
startPositionnumberNoOne-based list start position; defaults to 1
maxResultsnumberNoList page size from 1 through 100; defaults to 25

Output

ParameterTypeDescription
startPositionnumberOne-based position of the first item in this response
maxResultsnumberActual number of items reported for this response
nextStartPositionnumberPosition to use when explicitly requesting the next page
hasMorebooleanConservative indication that another page may exist
timestringQuickBooks response timestamp
itemjsonNative QuickBooks attachment metadata
IdstringQuickBooks attachment ID
SyncTokenstringAttachment sync token
FileNamestringAttached file name
ContentTypestringAttached file MIME type
SizenumberAttached file size in bytes
NotestringAttachment note or description
CategorystringNative QuickBooks attachment category
AttachableRefarrayQuickBooks entities referenced by this attachment
EntityRefjsonAttached entity type and operational ID
IncludeOnSendbooleanWhether QuickBooks includes the attachment when sending
MetaDatajsonAttachment creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
domainstringQuickBooks domain
sparsebooleanWhether this is a sparse entity
itemsarrayNative QuickBooks attachment metadata page
IdstringQuickBooks attachment ID
SyncTokenstringAttachment sync token
FileNamestringAttached file name
ContentTypestringAttached file MIME type
SizenumberAttached file size in bytes
NotestringAttachment note or description
CategorystringNative QuickBooks attachment category
AttachableRefarrayQuickBooks entities referenced by this attachment
EntityRefjsonAttached entity type and operational ID
IncludeOnSendbooleanWhether QuickBooks includes the attachment when sending
MetaDatajsonAttachment creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
domainstringQuickBooks domain
sparsebooleanWhether this is a sparse entity

QuickBooks Add Attachment

Attach one supported file or one note to a fixed QuickBooks entity

Input

ParameterTypeRequiredDescription
attachmentKindstringYesAttachment kind: file or note
targetTypestringYesFixed QuickBooks entity type to attach to
targetIdstringYesQuickBooks target entity ID
filefileNoSingle Sim file to upload
fileNamestringNoOptional safe filename override
contentTypestringNoOptional compatible QuickBooks MIME type override
descriptionstringNoOptional file attachment description
notestringNoRequired nonempty note text in Note mode

Output

ParameterTypeDescription
attachmentjsonCreated native QuickBooks attachment metadata
IdstringQuickBooks attachment ID
SyncTokenstringAttachment sync token
FileNamestringAttached file name
ContentTypestringAttached file MIME type
SizenumberAttached file size in bytes
NotestringAttachment note or description
CategorystringNative QuickBooks attachment category
AttachableRefarrayQuickBooks entities referenced by this attachment
EntityRefjsonAttached entity type and operational ID
IncludeOnSendbooleanWhether QuickBooks includes the attachment when sending
MetaDatajsonAttachment creation and update timestamps
CreateTimestringEntity creation timestamp
LastUpdatedTimestringEntity last-updated timestamp
domainstringQuickBooks domain
sparsebooleanWhether this is a sparse entity
attachmentIdstringCreated QuickBooks attachment ID
attachmentKindstringCreated attachment kind
targetTypestringQuickBooks target entity type
targetIdstringQuickBooks target entity ID
timestringQuickBooks response timestamp

QuickBooks Download Attachment

Download a QuickBooks file attachment as a stored Sim file

Input

ParameterTypeRequiredDescription
attachmentIdstringYesQuickBooks attachment ID
fileNamestringNoOptional safe filename override

Output

ParameterTypeDescription
filefileDownloaded file stored in execution files
fileNamestringSafe downloaded filename
mimeTypestringDownloaded file MIME type
sizenumberDownloaded file size in bytes
attachmentIdstringDownloaded QuickBooks attachment ID

Triggers

A Trigger is a block that starts a workflow when an event happens in this service.

QuickBooks Account Events

Trigger when selected Account events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_account_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Bill Events

Trigger when selected Bill events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_bill_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Bill Payment Events

Trigger when selected Bill Payment events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_bill_payment_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Budget Events

Trigger when selected Budget events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_budget_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Class Events

Trigger when selected Class events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_class_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Credit Memo Events

Trigger when selected Credit Memo events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_credit_memo_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Currency Events

Trigger when selected Currency events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_currency_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Customer Events

Trigger when selected Customer events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_customer_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Department Events

Trigger when selected Department events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_department_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Deposit Events

Trigger when selected Deposit events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_deposit_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Employee Events

Trigger when selected Employee events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_employee_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Estimate Events

Trigger when selected Estimate events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_estimate_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Invoice Events

Trigger when selected Invoice events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_invoice_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Item Events

Trigger when selected Item events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_item_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Journal Code Events

Trigger when selected Journal Code events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_journal_code_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Journal Entry Events

Trigger when selected Journal Entry events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_journal_entry_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Payment Events

Trigger when selected Payment events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_payment_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Payment Method Events

Trigger when selected Payment Method events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_payment_method_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Preferences Updated

Trigger when QuickBooks Preferences are updated

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Purchase Events

Trigger when selected Purchase events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_purchase_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Purchase Order Events

Trigger when selected Purchase Order events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_purchase_order_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Refund Receipt Events

Trigger when selected Refund Receipt events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_refund_receipt_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Sales Receipt Events

Trigger when selected Sales Receipt events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_sales_receipt_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Tax Agency Events

Trigger when selected Tax Agency events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_tax_agency_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Term Events

Trigger when selected Term events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_term_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Time Activity Events

Trigger when selected Time Activity events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_time_activity_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Transfer Events

Trigger when selected Transfer events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_transfer_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Vendor Credit Events

Trigger when selected Vendor Credit events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_vendor_credit_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

QuickBooks Vendor Events

Trigger when selected Vendor events occur in QuickBooks

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesQuickBooks Account
eventTypes_quickbooks_vendor_eventsstringYesEvent Types

Output

ParameterTypeDescription
eventIdstringIntuit webhook event ID
eventTypestringFull Intuit CloudEvent type
entityTypestringQuickBooks entity type
actionstringQuickBooks webhook action
entityIdstringQuickBooks entity ID
realmIdstringQuickBooks company realm ID
eventTimestringEvent timestamp
specVersionstringCloudEvents specification version
sourcestringIntuit event source
contentTypestringEvent content type, when provided
datajsonOptional event data supplied by Intuit

On this page

Usage Instructions
Actions
QuickBooks Get Company Info
Input
Output
QuickBooks Read Master Data
Input
Output
QuickBooks Create Customer
Input
Output
QuickBooks Update Customer
Input
Output
QuickBooks Create Employee
Input
Output
QuickBooks Update Employee
Input
Output
QuickBooks Create Vendor
Input
Output
QuickBooks Update Vendor
Input
Output
QuickBooks Create Item
Input
Output
QuickBooks Update Item
Input
Output
QuickBooks Read Sales Transactions
Input
Output
QuickBooks Create Estimate
Input
Output
QuickBooks Update Estimate
Input
Output
QuickBooks Create Invoice
Input
Output
QuickBooks Update Invoice
Input
Output
QuickBooks Void Invoice
Input
Output
QuickBooks Create Sales Receipt
Input
Output
QuickBooks Update Sales Receipt
Input
Output
QuickBooks Create Customer Payment
Input
Output
QuickBooks Update Customer Payment
Input
Output
QuickBooks Void Customer Payment
Input
Output
QuickBooks Create Credit Memo
Input
Output
QuickBooks Update Credit Memo
Input
Output
QuickBooks Create Refund Receipt
Input
Output
QuickBooks Update Refund Receipt
Input
Output
QuickBooks Read Purchasing Transactions
Input
Output
QuickBooks Create Purchase Order
Input
Output
QuickBooks Update Purchase Order
Input
Output
QuickBooks Create Bill
Input
Output
QuickBooks Update Bill
Input
Output
QuickBooks Create Bill Payment
Input
Output
QuickBooks Update Bill Payment
Input
Output
QuickBooks Create Vendor Credit
Input
Output
QuickBooks Update Vendor Credit
Input
Output
QuickBooks Create Purchase
Input
Output
QuickBooks Update Purchase
Input
Output
QuickBooks Read Accounting Transactions
Input
Output
QuickBooks Create Journal Entry
Input
Output
QuickBooks Update Journal Entry
Input
Output
QuickBooks Create Deposit
Input
Output
QuickBooks Update Deposit
Input
Output
QuickBooks Run Financial Report
Input
Output
QuickBooks Email Transaction
Input
Output
QuickBooks Download Transaction PDF
Input
Output
QuickBooks Read Attachments
Input
Output
QuickBooks Add Attachment
Input
Output
QuickBooks Download Attachment
Input
Output
Triggers
QuickBooks Account Events
Configuration
Output
QuickBooks Bill Events
Configuration
Output
QuickBooks Bill Payment Events
Configuration
Output
QuickBooks Budget Events
Configuration
Output
QuickBooks Class Events
Configuration
Output
QuickBooks Credit Memo Events
Configuration
Output
QuickBooks Currency Events
Configuration
Output
QuickBooks Customer Events
Configuration
Output
QuickBooks Department Events
Configuration
Output
QuickBooks Deposit Events
Configuration
Output
QuickBooks Employee Events
Configuration
Output
QuickBooks Estimate Events
Configuration
Output
QuickBooks Invoice Events
Configuration
Output
QuickBooks Item Events
Configuration
Output
QuickBooks Journal Code Events
Configuration
Output
QuickBooks Journal Entry Events
Configuration
Output
QuickBooks Payment Events
Configuration
Output
QuickBooks Payment Method Events
Configuration
Output
QuickBooks Preferences Updated
Configuration
Output
QuickBooks Purchase Events
Configuration
Output
QuickBooks Purchase Order Events
Configuration
Output
QuickBooks Refund Receipt Events
Configuration
Output
QuickBooks Sales Receipt Events
Configuration
Output
QuickBooks Tax Agency Events
Configuration
Output
QuickBooks Term Events
Configuration
Output
QuickBooks Time Activity Events
Configuration
Output
QuickBooks Transfer Events
Configuration
Output
QuickBooks Vendor Credit Events
Configuration
Output
QuickBooks Vendor Events
Configuration
Output