AptlyStar

QuickBooks

Manage QuickBooks Online customers, invoices, and accounting data

使用方法

Connect to QuickBooks Online to read and write customers, invoices, and chart-of-accounts entries, or run arbitrary QuickBooks queries. Uses Intuit OAuth 2.0; the company (realmId) is captured from the OAuth callback at sign-in time.

ツール

quickbooks_create_bill

Create a new bill (vendor expense) in QuickBooks Online

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
vendorIdstringはいVendor ID for the bill
linesjsonはいBill line items (JSON array). Each entry: { amount, accountId, description? }
txnDatestringいいえTransaction date (YYYY-MM-DD)
dueDatestringいいえDue date (YYYY-MM-DD)

出力

パラメータ型説明
billobjectCreated bill
↳ IdstringQuickBooks bill ID
↳ VendorRefobjectVendor reference
↳ TxnDatestringTransaction date (YYYY-MM-DD)
↳ DueDatestringDue date (YYYY-MM-DD)
↳ TotalAmtnumberTotal bill amount
↳ BalancenumberOutstanding balance
↳ LinearrayBill line items
↳ CurrencyRefobjectCurrency reference
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
billIdstringNew bill ID

quickbooks_create_customer

Create a new customer in QuickBooks Online

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
displayNamestringはいDisplay name (must be unique within the company)
companyNamestringいいえCompany name
givenNamestringいいえFirst name
familyNamestringいいえLast name
primaryEmailstringいいえPrimary email address
primaryPhonestringいいえPrimary phone number
notesstringいいえFree-form notes

出力

パラメータ型説明
customerobjectCreated customer
↳ IdstringQuickBooks customer ID
↳ DisplayNamestringDisplay name shown in lists and forms
↳ CompanyNamestringCompany name
↳ GivenNamestringFirst name
↳ FamilyNamestringLast name
↳ PrimaryEmailAddrobjectPrimary email object with Address
↳ PrimaryPhoneobjectPrimary phone object with FreeFormNumber
↳ ActivebooleanWhether the customer is active
↳ BalancenumberOpen balance owed by the customer
↳ CurrencyRefobjectCurrency reference (value, name)
↳ NotesstringFree-form notes
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
customerIdstringNew customer ID

quickbooks_create_invoice

Create a new invoice in QuickBooks Online

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
customerIdstringはいCustomer ID to bill
linesjsonはいInvoice line items (JSON array). Each entry: { itemId, amount, quantity?, description?, itemName? }. itemId is required (use list_items to look up valid IDs).
txnDatestringいいえTransaction date (YYYY-MM-DD)
dueDatestringいいえDue date (YYYY-MM-DD)
customerMemostringいいえMemo shown to the customer on the invoice
billEmailstringいいえEmail address to bill (used by Send Invoice flows)

出力

パラメータ型説明
invoiceobjectCreated invoice
↳ IdstringQuickBooks invoice ID
↳ DocNumberstringInvoice document number
↳ TxnDatestringInvoice transaction date (YYYY-MM-DD)
↳ DueDatestringInvoice due date (YYYY-MM-DD)
↳ CustomerRefobjectReference to the customer (value, name)
↳ LinearrayInvoice line items
↳ TotalAmtnumberTotal amount of the invoice
↳ BalancenumberOutstanding balance on the invoice
↳ CurrencyRefobjectCurrency reference
↳ CustomerMemoobjectCustomer-facing memo
↳ BillEmailobjectBilling email object
↳ EmailStatusstringEmail send status (NotSet, NeedToSend, EmailSent)
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
invoiceIdstringNew invoice ID

quickbooks_create_item

Create a new item (product or service) in QuickBooks Online

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
namestringはいItem name (must be unique within the company)
typestringはいItem type — Service or NonInventory (Inventory not supported in MVP)
incomeAccountIdstringはいIncome account ID to associate with the item
descriptionstringいいえItem description
unitPricenumberいいえUnit price for the item

出力

パラメータ型説明
itemobjectCreated item
↳ IdstringQuickBooks item ID
↳ NamestringItem name
↳ DescriptionstringItem description
↳ TypestringItem type (Service, Inventory, NonInventory)
↳ ActivebooleanWhether the item is active
↳ UnitPricenumberUnit price
↳ IncomeAccountRefobjectIncome account reference
↳ ExpenseAccountRefobjectExpense account reference
↳ AssetAccountRefobjectAsset account reference
↳ QtyOnHandnumberQuantity on hand (Inventory only)
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
itemIdstringNew item ID

quickbooks_create_payment

Record a customer payment in QuickBooks Online

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
customerIdstringはいCustomer ID making the payment
amountnumberはいTotal payment amount
invoiceIdstringいいえOptional invoice ID to apply the payment to
paymentMethodIdstringいいえPayment method ID
txnDatestringいいえTransaction date (YYYY-MM-DD)
paymentRefNumstringいいえPayment reference number (e.g., check number)

出力

パラメータ型説明
paymentobjectCreated payment
↳ IdstringQuickBooks payment ID
↳ TxnDatestringTransaction date (YYYY-MM-DD)
↳ CustomerRefobjectCustomer reference
↳ TotalAmtnumberTotal payment amount
↳ UnappliedAmtnumberUnapplied amount
↳ PaymentMethodRefobjectPayment method reference
↳ PaymentRefNumstringPayment reference number
↳ LinearrayPayment line items / linked transactions
↳ CurrencyRefobjectCurrency reference
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
paymentIdstringNew payment ID

quickbooks_create_vendor

Create a new vendor in QuickBooks Online

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
displayNamestringはいDisplay name (must be unique within the company)
companyNamestringいいえCompany name
givenNamestringいいえFirst name
familyNamestringいいえLast name
primaryEmailstringいいえPrimary email address
primaryPhonestringいいえPrimary phone number

出力

パラメータ型説明
vendorobjectCreated vendor
↳ IdstringQuickBooks vendor ID
↳ DisplayNamestringDisplay name
↳ CompanyNamestringCompany name
↳ GivenNamestringFirst name
↳ FamilyNamestringLast name
↳ PrimaryEmailAddrobjectPrimary email object with Address
↳ PrimaryPhoneobjectPrimary phone object with FreeFormNumber
↳ ActivebooleanWhether the vendor is active
↳ BalancenumberOpen balance owed to the vendor
↳ CurrencyRefobjectCurrency reference
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
vendorIdstringNew vendor ID

quickbooks_get_company_info

Retrieve company information for the connected QuickBooks Online company

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time

出力

パラメータ型説明
companyInfoobjectCompany information record
↳ IdstringQuickBooks company ID (realmId)
↳ CompanyNamestringCompany name
↳ LegalNamestringLegal name
↳ CompanyAddrobjectCompany address
↳ CompanyStartDatestringCompany start date
↳ FiscalYearStartMonthstringFiscal year start month
↳ CountrystringCountry code
↳ EmailobjectPrimary email object
↳ WebAddrobjectWeb address
↳ SupportedLanguagesstringSupported languages
↳ NameValuearrayCustom name/value pairs
↳ MetaDataobjectCreate/update timestamps

quickbooks_get_customer

Retrieve a single QuickBooks customer by ID

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
customerIdstringはいQuickBooks customer ID

出力

パラメータ型説明
customerobjectCustomer record
↳ IdstringQuickBooks customer ID
↳ DisplayNamestringDisplay name shown in lists and forms
↳ CompanyNamestringCompany name
↳ GivenNamestringFirst name
↳ FamilyNamestringLast name
↳ PrimaryEmailAddrobjectPrimary email object with Address
↳ PrimaryPhoneobjectPrimary phone object with FreeFormNumber
↳ ActivebooleanWhether the customer is active
↳ BalancenumberOpen balance owed by the customer
↳ CurrencyRefobjectCurrency reference (value, name)
↳ NotesstringFree-form notes
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
customerIdstringCustomer ID

quickbooks_get_invoice

Retrieve a single QuickBooks invoice by ID

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
invoiceIdstringはいQuickBooks invoice ID

出力

パラメータ型説明
invoiceobjectInvoice record
↳ IdstringQuickBooks invoice ID
↳ DocNumberstringInvoice document number
↳ TxnDatestringInvoice transaction date (YYYY-MM-DD)
↳ DueDatestringInvoice due date (YYYY-MM-DD)
↳ CustomerRefobjectReference to the customer (value, name)
↳ LinearrayInvoice line items
↳ TotalAmtnumberTotal amount of the invoice
↳ BalancenumberOutstanding balance on the invoice
↳ CurrencyRefobjectCurrency reference
↳ CustomerMemoobjectCustomer-facing memo
↳ BillEmailobjectBilling email object
↳ EmailStatusstringEmail send status (NotSet, NeedToSend, EmailSent)
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
invoiceIdstringInvoice ID

quickbooks_get_vendor

Retrieve a single QuickBooks vendor by ID

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
vendorIdstringはいQuickBooks vendor ID

出力

パラメータ型説明
vendorobjectVendor record
↳ IdstringQuickBooks vendor ID
↳ DisplayNamestringDisplay name
↳ CompanyNamestringCompany name
↳ GivenNamestringFirst name
↳ FamilyNamestringLast name
↳ PrimaryEmailAddrobjectPrimary email object with Address
↳ PrimaryPhoneobjectPrimary phone object with FreeFormNumber
↳ ActivebooleanWhether the vendor is active
↳ BalancenumberOpen balance owed to the vendor
↳ CurrencyRefobjectCurrency reference
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
vendorIdstringVendor ID

quickbooks_list_accounts

List chart-of-accounts entries from QuickBooks Online

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
maxResultsnumberいいえMaximum number of accounts to return (default 100, max 1000)
startPositionnumberいいえPagination start position (1-indexed)
wherestringいいえOptional WHERE clause (e.g., "AccountType = 'Income'")

出力

パラメータ型説明
accountsarrayArray of accounts
↳ IdstringQuickBooks account ID
↳ NamestringAccount name
↳ AccountTypestringHigh-level account type (Income, Expense, etc.)
↳ AccountSubTypestringAccount sub-type
↳ ClassificationstringAsset, Liability, Equity, Revenue, or Expense
↳ CurrentBalancenumberCurrent account balance
↳ ActivebooleanWhether the account is active
↳ CurrencyRefobjectCurrency reference
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
totalCountnumberNumber of accounts returned

quickbooks_list_bills

List bills from QuickBooks Online

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
maxResultsnumberいいえMaximum number of bills to return (default 100, max 1000)
startPositionnumberいいえPagination start position (1-indexed)
wherestringいいえOptional WHERE clause

出力

パラメータ型説明
billsarrayArray of bills
↳ IdstringQuickBooks bill ID
↳ VendorRefobjectVendor reference
↳ TxnDatestringTransaction date (YYYY-MM-DD)
↳ DueDatestringDue date (YYYY-MM-DD)
↳ TotalAmtnumberTotal bill amount
↳ BalancenumberOutstanding balance
↳ LinearrayBill line items
↳ CurrencyRefobjectCurrency reference
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
totalCountnumberNumber of bills returned

quickbooks_list_customers

List customers from QuickBooks Online

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
maxResultsnumberいいえMaximum number of customers to return (default 100, max 1000)
startPositionnumberいいえPagination start position (1-indexed)
wherestringいいえOptional WHERE clause (e.g., "Active = true AND DisplayName LIKE 'A%'")

出力

パラメータ型説明
customersarrayArray of QuickBooks customers
↳ IdstringQuickBooks customer ID
↳ DisplayNamestringDisplay name shown in lists and forms
↳ CompanyNamestringCompany name
↳ GivenNamestringFirst name
↳ FamilyNamestringLast name
↳ PrimaryEmailAddrobjectPrimary email object with Address
↳ PrimaryPhoneobjectPrimary phone object with FreeFormNumber
↳ ActivebooleanWhether the customer is active
↳ BalancenumberOpen balance owed by the customer
↳ CurrencyRefobjectCurrency reference (value, name)
↳ NotesstringFree-form notes
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
totalCountnumberNumber of customers returned

quickbooks_list_estimates

List estimates from QuickBooks Online

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
maxResultsnumberいいえMaximum number of estimates to return (default 100, max 1000)
startPositionnumberいいえPagination start position (1-indexed)
wherestringいいえOptional WHERE clause

出力

パラメータ型説明
estimatesarrayArray of estimates
↳ IdstringQuickBooks estimate ID
↳ DocNumberstringEstimate document number
↳ TxnDatestringTransaction date (YYYY-MM-DD)
↳ ExpirationDatestringExpiration date (YYYY-MM-DD)
↳ CustomerRefobjectCustomer reference
↳ LinearrayEstimate line items
↳ TotalAmtnumberTotal estimate amount
↳ TxnStatusstringEstimate status (Pending, Accepted, etc.)
↳ EmailStatusstringEmail send status
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
totalCountnumberNumber of estimates returned

quickbooks_list_invoices

List invoices from QuickBooks Online

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
maxResultsnumberいいえMaximum number of invoices to return (default 100, max 1000)
startPositionnumberいいえPagination start position (1-indexed)
wherestringいいえOptional WHERE clause (e.g., "Balance > '0'")

出力

パラメータ型説明
invoicesarrayArray of invoices
↳ IdstringQuickBooks invoice ID
↳ DocNumberstringInvoice document number
↳ TxnDatestringInvoice transaction date (YYYY-MM-DD)
↳ DueDatestringInvoice due date (YYYY-MM-DD)
↳ CustomerRefobjectReference to the customer (value, name)
↳ LinearrayInvoice line items
↳ TotalAmtnumberTotal amount of the invoice
↳ BalancenumberOutstanding balance on the invoice
↳ CurrencyRefobjectCurrency reference
↳ CustomerMemoobjectCustomer-facing memo
↳ BillEmailobjectBilling email object
↳ EmailStatusstringEmail send status (NotSet, NeedToSend, EmailSent)
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
totalCountnumberNumber of invoices returned

quickbooks_list_items

List items (products and services) from QuickBooks Online

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
maxResultsnumberいいえMaximum number of items to return (default 100, max 1000)
startPositionnumberいいえPagination start position (1-indexed)
wherestringいいえOptional WHERE clause (e.g., "Type = 'Service'")

出力

パラメータ型説明
itemsarrayArray of items
↳ IdstringQuickBooks item ID
↳ NamestringItem name
↳ DescriptionstringItem description
↳ TypestringItem type (Service, Inventory, NonInventory)
↳ ActivebooleanWhether the item is active
↳ UnitPricenumberUnit price
↳ IncomeAccountRefobjectIncome account reference
↳ ExpenseAccountRefobjectExpense account reference
↳ AssetAccountRefobjectAsset account reference
↳ QtyOnHandnumberQuantity on hand (Inventory only)
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
totalCountnumberNumber of items returned

quickbooks_list_payments

List payments from QuickBooks Online

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
maxResultsnumberいいえMaximum number of payments to return (default 100, max 1000)
startPositionnumberいいえPagination start position (1-indexed)
wherestringいいえOptional WHERE clause

出力

パラメータ型説明
paymentsarrayArray of payments
↳ IdstringQuickBooks payment ID
↳ TxnDatestringTransaction date (YYYY-MM-DD)
↳ CustomerRefobjectCustomer reference
↳ TotalAmtnumberTotal payment amount
↳ UnappliedAmtnumberUnapplied amount
↳ PaymentMethodRefobjectPayment method reference
↳ PaymentRefNumstringPayment reference number
↳ LinearrayPayment line items / linked transactions
↳ CurrencyRefobjectCurrency reference
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
totalCountnumberNumber of payments returned

quickbooks_list_vendors

List vendors from QuickBooks Online

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
maxResultsnumberいいえMaximum number of vendors to return (default 100, max 1000)
startPositionnumberいいえPagination start position (1-indexed)
wherestringいいえOptional WHERE clause (e.g., "Active = true")

出力

パラメータ型説明
vendorsarrayArray of vendors
↳ IdstringQuickBooks vendor ID
↳ DisplayNamestringDisplay name
↳ CompanyNamestringCompany name
↳ GivenNamestringFirst name
↳ FamilyNamestringLast name
↳ PrimaryEmailAddrobjectPrimary email object with Address
↳ PrimaryPhoneobjectPrimary phone object with FreeFormNumber
↳ ActivebooleanWhether the vendor is active
↳ BalancenumberOpen balance owed to the vendor
↳ CurrencyRefobjectCurrency reference
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
totalCountnumberNumber of vendors returned

quickbooks_query

Run a QuickBooks Online query using SQL-like syntax (example: SELECT * FROM Item WHERE Active = true)

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
querystringはいQuickBooks Query Language statement (e.g., "SELECT * FROM Vendor WHERE Active = true MAXRESULTS 50")

出力

パラメータ型説明
resultsjsonRaw QueryResponse object from QuickBooks
totalCountnumberReported total count

quickbooks_send_invoice

Email a QuickBooks invoice to a recipient

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
invoiceIdstringはいInvoice ID to send
sendTostringいいえEmail address override; defaults to BillEmail on the invoice

出力

パラメータ型説明
invoiceobjectInvoice after send
↳ IdstringQuickBooks invoice ID
↳ DocNumberstringInvoice document number
↳ TxnDatestringInvoice transaction date (YYYY-MM-DD)
↳ DueDatestringInvoice due date (YYYY-MM-DD)
↳ CustomerRefobjectReference to the customer (value, name)
↳ LinearrayInvoice line items
↳ TotalAmtnumberTotal amount of the invoice
↳ BalancenumberOutstanding balance on the invoice
↳ CurrencyRefobjectCurrency reference
↳ CustomerMemoobjectCustomer-facing memo
↳ BillEmailobjectBilling email object
↳ EmailStatusstringEmail send status (NotSet, NeedToSend, EmailSent)
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
invoiceIdstringInvoice ID

quickbooks_update_customer

Sparse-update an existing QuickBooks customer

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
customerIdstringはいCustomer ID to update
syncTokenstringはいCurrent SyncToken from the customer record (required for updates)
displayNamestringいいえDisplay name
companyNamestringいいえCompany name
givenNamestringいいえFirst name
familyNamestringいいえLast name
primaryEmailstringいいえPrimary email address
primaryPhonestringいいえPrimary phone number
notesstringいいえFree-form notes

出力

パラメータ型説明
customerobjectUpdated customer
↳ IdstringQuickBooks customer ID
↳ DisplayNamestringDisplay name shown in lists and forms
↳ CompanyNamestringCompany name
↳ GivenNamestringFirst name
↳ FamilyNamestringLast name
↳ PrimaryEmailAddrobjectPrimary email object with Address
↳ PrimaryPhoneobjectPrimary phone object with FreeFormNumber
↳ ActivebooleanWhether the customer is active
↳ BalancenumberOpen balance owed by the customer
↳ CurrencyRefobjectCurrency reference (value, name)
↳ NotesstringFree-form notes
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
customerIdstringCustomer ID

quickbooks_update_invoice

Update an existing QuickBooks invoice (sparse update — date/memo/email only; line items cannot be modified)

入力

パラメータ型必須説明
realmIdstringはいQuickBooks company ID (realmId) — captured at OAuth time
invoiceIdstringはいInvoice ID to update
syncTokenstringはいCurrent SyncToken from the invoice record (required for updates)
dueDatestringいいえDue date (YYYY-MM-DD)
customerMemostringいいえCustomer-facing memo
billEmailstringいいえBilling email address

出力

パラメータ型説明
invoiceobjectUpdated invoice
↳ IdstringQuickBooks invoice ID
↳ DocNumberstringInvoice document number
↳ TxnDatestringInvoice transaction date (YYYY-MM-DD)
↳ DueDatestringInvoice due date (YYYY-MM-DD)
↳ CustomerRefobjectReference to the customer (value, name)
↳ LinearrayInvoice line items
↳ TotalAmtnumberTotal amount of the invoice
↳ BalancenumberOutstanding balance on the invoice
↳ CurrencyRefobjectCurrency reference
↳ CustomerMemoobjectCustomer-facing memo
↳ BillEmailobjectBilling email object
↳ EmailStatusstringEmail send status (NotSet, NeedToSend, EmailSent)
↳ MetaDataobjectCreate/update timestamps
↳ SyncTokenstringOptimistic concurrency token; required for sparse updates
invoiceIdstringInvoice ID

On this page