Procedures

Automation procedures in the QuickBooks book.

The following documentation is for QuickBooks v2.6.0 (BDK).

Ensure that you have installed or connected the QuickBooks book and created a new playground before using these automation procedures.

to attach a file to the (bill) and get the attachment

Upload an attachment to an existing bill in QuickBooks.

Input Concepts

Concept	Description	Type	Required	Default Value
bill	The Bill concept object to attach the file to.	quickbooks bill	Yes	(no default)
file	The file-like object to upload.	file	Yes	(no default)
file name	The name of the file to be attached.	text	Yes	(no default)
note	Optional note to add to the attachment.	text	No	(no default)

Output Concepts

Concept	Description	Type
attachment	The Attachment concept object with updated attachment information.	quickbooks attachment

Examples

the bill
the file
attach the file to the bill
  the file name is "attachment.pdf"
  the note is "This is an attachment note"

to create a bill

Create a new bill in QuickBooks from the provided bill details.

Input Concepts

Concept	Description	Type	Required	Default Value
bill	A BillInput object containing all bill details.	quickbooks bill input	Yes	(no default)

Output Concepts

Concept	Description	Type
answer	The newly created bill.	quickbooks bill

Examples

Create a bill with mixed line items.

set the department's company id to 9341455406391846
the vendor
get '{"items":[{"name":"Sprinkler Heads","amount":200.00,"quantity":4,"unit_price":50.00},{"account_name":"Supplies","amount":75.00,"description":"Miscellaneous office expenses"}]}' as a json
use the above as bill
set the bill's vendor to the vendor
create the bill

Create a bill with all optional fields for item-based line items.

set the department's company id to 9341455406391846
the vendor
the customer
get the customer as a string
get '{"terms":"Net 30","bill_date":"2025-07-15","due_date":"2025-08-14","bill_no":"COMPLETE-123","items":[{"name":"Sprinkler Heads","amount":200.00,"description":"Premium sprinkler heads","customer": {the customer},"quantity":4,"unit_price":50.00,"billable_status":"Billable"}]}' as a json
use the above as bill
set the bill's vendor to the vendor
create the bill

Create a bill with account-based line items.

set the department's company id to 9341455406391846
the vendor
the customer
get the customer as a string
get '{"items":[{"account_name":"Supplies","amount":150.00,"description":"Office supplies expense","customer": {the customer}}]}' as a json
set the bill's vendor to the vendor
use the above as bill
create the bill

to create a bill from a (purchase order)

Create a new bill in QuickBooks based on an existing purchase order.

Input Concepts

Concept	Description	Type	Required	Default Value
purchase order	The purchase order to convert into a bill.	quickbooks purchase order	Yes	(no default)

Output Concepts

Concept	Description	Type
purchase order	The newly created bill.	quickbooks bill

Examples

Create a bill for a specific purchase order by doc number.

retrieve the purchase orders whose doc_number is "PO-12345"
use the first purchase order as the purchase order
create the bill from the purchase order

to create an invoice

Create a new invoice in QuickBooks from the provided invoice details.

Input Concepts

Concept	Description	Type	Required	Default Value
invoice	An InvoiceInput object containing all invoice details.	quickbooks invoice input	Yes	(no default)

Output Concepts

Concept	Description	Type
answer	The newly created invoice.	quickbooks invoice

Examples

Create an invoice with sales item line.

set the department's company id to 9341455406391846
the customer
get '{"items":[{"name":"Sprinkler Heads","amount":200.00,"quantity":4,"unit_price":50.00}]}' as a json
use the above as invoice
set the invoice's customer to the customer
create the invoice

Create an invoice with all optional fields.

set the department's company id to 9341455406391846
the customer
get '{"terms":"Net 30","invoice_date":"2025-07-15","due_date":"2025-08-14","invoice_no":"INV-001","items":[{"name":"Sprinkler Heads","amount":200.00,"description":"Premium sprinkler heads","quantity":4,"unit_price":50.00}]}' as a json
use the above as invoice
set the invoice's customer to the customer
create the invoice

Create an invoice with description-only lines.

set the department's company id to 9341455406391846
the customer
get '{"items":[{"description":"This is a note line"},{"name":"Sprinkler Heads","amount":100.00}]}' as a json
use the above as invoice
set the invoice's customer to the customer
create the invoice

to delete an (invoice)

Delete/void an invoice in QuickBooks.

QuickBooks marks invoices as inactive rather than hard deleting them.

Input Concepts

Concept	Description	Type	Required	Default Value
invoice	The Invoice concept object to delete.	quickbooks invoice	Yes	(no default)

Output Concepts

Concept	Description	Type
invoice	None	thing

Examples

retrieve the invoices whose doc_number is "INV-001"
use the first invoice as the invoice
delete the invoice

to delete an invoice by id

Delete/void an invoice in QuickBooks by invoice ID.

QuickBooks marks invoices as inactive rather than hard deleting them.

Input Concepts

Concept	Description	Type	Required	Default Value
invoice id	The invoice ID to delete.	text	Yes	(no default)

Examples

delete the invoice by id
    the invoice id is 12345

to edit a bill

Edit an existing bill in QuickBooks by updating it with new information.

Input Concepts

Concept	Description	Type	Required	Default Value
bill	The Bill concept object containing the updated bill information.	quickbooks bill	Yes	(no default)

Output Concepts

Concept	Description	Type
answer	The updated bill from QuickBooks.	quickbooks bill

Examples

the bill
the customer
the bill's "items"
use the above as the lines
get the first line as the item
set the item's "billable_status" to "BILLABLE"
set the item's customer to the customer
set the bill's "items" to the items
edit the bill

to edit an (invoice)

Edit an existing invoice in QuickBooks by updating it with new information.

Input Concepts

Concept	Description	Type	Required	Default Value
invoice	The Invoice concept object containing the updated invoice information.	quickbooks invoice	Yes	(no default)

Output Concepts

Concept	Description	Type
invoice	The updated invoice from QuickBooks.	quickbooks invoice

Examples

retrieve the invoices whose doc_number is "INV-001"
use the first invoice as the invoice
set the invoice's due_date to "2025-02-15"
set the invoice's invoice_date to "2025-01-15"
edit the invoice

to retrieve (bills)

FILTER - CAPABLE

Retrieve bills in QuickBooks from the company.

Input Concepts

Concept	Description	Type	Required	Default Value
limit	The maximum number of bills to retrieve.	number	No	(no default)
offset	The number which starts the bills to retrieve.	number	No	(no default)

Output Concepts

Concept	Description	Type
bills	The bills associated with the company.	quickbooks bill

Examples

retrieve the bills whose doc_number is "BILL-12345"

to retrieve (customers)

FILTER - CAPABLE

Retrieve customers in QuickBooks from the company.

Input Concepts

Concept	Description	Type	Required	Default Value
limit	The maximum number of customers to retrieve.	number	No	(no default)
offset	The number which starts the customers to retrieve.	number	No	(no default)

Output Concepts

Concept	Description	Type
customers	The customers associated with the company.	quickbooks customer

Examples

retrieve the customers whose display_name has "Cool"
use the first customer as the customer

to retrieve (invoices)

FILTER - CAPABLE

Retrieve invoices in QuickBooks from the company.

Input Concepts

Concept	Description	Type	Required	Default Value
limit	The maximum number of invoices to retrieve.	number	No	(no default)
offset	The number which starts the invoices to retrieve.	number	No	(no default)

Output Concepts

Concept	Description	Type
invoices	The invoices associated with the company.	quickbooks invoice

Examples

retrieve the invoices whose doc_number is "INV-12345"

to retrieve (items)

FILTER - CAPABLE

Retrieve items in QuickBooks from the company.

Input Concepts

Concept	Description	Type	Required	Default Value
limit	The maximum number of items to retrieve.	number	No	(no default)
offset	The number which starts the items to retrieve.	number	No	(no default)

Output Concepts

Concept	Description	Type
items	The items associated with the company.	quickbooks item

Examples

retrieve the items whose name is "Sprinkler Heads"
retrieve the items whose type is "Category"
retrieve the items whose is_active is True

to retrieve (purchase orders)

FILTER - CAPABLE

Retrieve purchase orders in QuickBooks from the company.

Input Concepts

Concept	Description	Type	Required	Default Value
limit	The maximum number of purchase orders to retrieve.	number	No	(no default)
offset	The number which starts the purchase orders to retrieve.	number	No	(no default)

Output Concepts

Concept	Description	Type
purchase orders	The purchase orders associated with the company.	quickbooks purchase order

Examples

retrieve the purchase orders whose vendor_name is "ABC Company"
retrieve the purchase orders whose doc_number is "1004"
retrieve the purchase orders whose vendor_name has "ABC" and po_number is "PO-12345"

to retrieve (vendors)

FILTER - CAPABLE

Retrieve vendors in QuickBooks from the company.

Input Concepts

Concept	Description	Type	Required	Default Value
limit	The maximum number of messages to retrieve.	number	No	(no default)
offset	The number which starts the messages to retrieve.	number	No	(no default)

Output Concepts

Concept	Description	Type
vendors	The vendors associated with the company.	quickbooks vendor

Examples

retrieve the vendors whose display_name is "Pam Seitz"
use the first vendor as the vendor

to retrieve a (report)

Retrieve a specific report from QuickBooks.

This procedure handles both summary and detail AR/AP reports.

Input Concepts

Concept	Description	Type	Required	Default Value
report type	The type of report to retrieve (AR summary, AR detail, AP summary, AP detail, account list detail, or transaction list).	enum[account_list_detail, ap_detail, ap_summary, ar_detail, ar_summary, transaction_list]	Yes	(no default)
date macro	Predefined date range (e.g., "All", "This Month", "Last Quarter"). Mutually exclusive with start_date/end_date.	text	No	(no default)
start date	Start date for custom range in YYYY-MM-DD format. Must be used with end_date.	text	No	(no default)
end date	End date for custom range in YYYY-MM-DD format. Must be used with start_date.	text	No	(no default)

Output Concepts

Concept	Description	Type
report	A Report object containing the report header, columns, and grouped table sections.	quickbooks report

Examples

retrieve the report from quickbooks
    the report type is "AP_DETAIL"
    the date macro is "All"
retrieve the report from quickbooks
    the report type is "ACCOUNT_LIST_DETAIL"
    the date macro is "This Month"
retrieve the report from quickbooks
    the report type is "TRANSACTION_LIST"
    the start date is "2024-01-01"
    the end date is "2024-12-31"

to update an (item)

Update an existing item in QuickBooks.

Input Concepts

Concept	Description	Type	Required	Default Value
item	The Item concept object containing the updated item information.	quickbooks item	Yes	(no default)

Output Concepts

Concept	Description	Type
item	The updated item from QuickBooks.	quickbooks item

Examples

retrieve the items whose name is "Sprinkler Heads"
use the first item as the item
set the item's unit_price to 75.00
set the item's description to "Updated description"
update the item