QuickBooks
Manage QuickBooks accounting data including customers, invoices, and payments
Integrates QuickBooks Online into your workflow. List and retrieve customers, create and update invoices, list invoices with filtering, and record payments. Ideal for automating accounting workflows and syncing financial data.
| Parameter | Type | Required | Description |
|---|
companyId | string | Yes | QuickBooks company (realm) ID |
maxResults | number | No | Maximum number of customers to return (default 100) |
startPosition | number | No | Starting position for pagination (1-based) |
| Parameter | Type | Description |
|---|
customers | array | List of QuickBooks customers |
↳ Id | string | Customer ID |
↳ DisplayName | string | Customer display name |
↳ Balance | number | Current balance |
↳ Active | boolean | Whether customer is active |
metadata | json | Pagination metadata |
↳ totalCount | number | Total number of customers |
↳ startPosition | number | Start position |
↳ maxResults | number | Max results returned |
| Parameter | Type | Required | Description |
|---|
companyId | string | Yes | QuickBooks company (realm) ID |
customerId | string | Yes | QuickBooks customer ID |
| Parameter | Type | Description |
|---|
customer | json | QuickBooks customer object |
↳ Id | string | Customer ID |
↳ DisplayName | string | Customer display name |
↳ Balance | number | Current balance |
↳ Active | boolean | Whether customer is active |
| Parameter | Type | Required | Description |
|---|
companyId | string | Yes | QuickBooks company (realm) ID |
maxResults | number | No | Maximum number of invoices to return (default 100) |
customerId | string | No | Filter invoices by customer ID |
| Parameter | Type | Description |
|---|
invoices | array | List of QuickBooks invoices |
↳ Id | string | Invoice ID |
↳ DocNumber | string | Invoice number |
↳ TotalAmt | number | Total amount |
↳ Balance | number | Remaining balance |
metadata | json | Query metadata |
↳ totalCount | number | Total invoice count |
| Parameter | Type | Required | Description |
|---|
companyId | string | Yes | QuickBooks company (realm) ID |
customerId | string | Yes | Customer ID to bill |
customerName | string | No | Customer display name (optional) |
txnDate | string | No | Invoice date (YYYY-MM-DD, defaults to today) |
dueDate | string | No | Due date (YYYY-MM-DD) |
lineItems | string | Yes | JSON array of line items: [{"Description":"Service","Amount":100,"DetailType":"SalesItemLineDetail","SalesItemLineDetail":{"ItemRef":{"value":"1"}}}] |
| Parameter | Type | Description |
|---|
invoice | json | Created QuickBooks invoice |
↳ Id | string | Invoice ID |
↳ DocNumber | string | Invoice number |
↳ TotalAmt | number | Total amount |
↳ Balance | number | Remaining balance |
metadata | json | Invoice creation metadata |
↳ invoiceId | string | New invoice ID |
↳ docNumber | string | Invoice document number |
| Parameter | Type | Required | Description |
|---|
companyId | string | Yes | QuickBooks company (realm) ID |
invoiceId | string | Yes | ID of the invoice to update |
syncToken | string | Yes | SyncToken from the invoice read (required for optimistic locking) |
txnDate | string | No | Updated invoice date (YYYY-MM-DD) |
dueDate | string | No | Updated due date (YYYY-MM-DD) |
lineItems | string | No | Updated JSON array of line items |
| Parameter | Type | Description |
|---|
invoice | json | Updated QuickBooks invoice |
↳ Id | string | Invoice ID |
↳ TotalAmt | number | Total amount |
↳ Balance | number | Remaining balance |
metadata | json | Update metadata |
↳ invoiceId | string | Invoice ID |
| Parameter | Type | Required | Description |
|---|
companyId | string | Yes | QuickBooks company (realm) ID |
customerId | string | Yes | Customer ID receiving the payment |
customerName | string | No | Customer display name (optional) |
totalAmt | number | Yes | Payment amount |
txnDate | string | No | Payment date (YYYY-MM-DD, defaults to today) |
invoiceId | string | No | Invoice ID to apply payment to (optional) |
| Parameter | Type | Description |
|---|
payment | json | Created QuickBooks payment |
↳ Id | string | Payment ID |
↳ TotalAmt | number | Payment amount |
↳ TxnDate | string | Payment date |
metadata | json | Payment creation metadata |
↳ paymentId | string | New payment ID |
